Autres/Rivendellaudio
1
0
Fork 0
mirror of https://github.com/ElvishArtisan/rivendell.git synced 2025-04-07 01:13:50 +02:00
Code Issues Projects Releases Wiki Activity

2020-09-23 Fred Gleason <fredg@paravelsystems.com>

Browse Source 
* Added a 'RD_DeletePodcast()' call to the rivwebcapi API.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason 2020-09-24 14:44:06 -04:00
parent 59d70ff1e7
commit 6081e620ff
9 changed files with 646 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ChangeLog
View File

@ -20345,3 +20345,5 @@
2020-09-23 Fred Gleason <fredg@paravelsystems.com>
* Added 'RD_PostPodcast()', 'RDRemovePodcast()' and
'RD_SavePodcast()' calls to the rivwebcapi API.
2020-09-23 Fred Gleason <fredg@paravelsystems.com>
* Added a 'RD_DeletePodcast()' call to the rivwebcapi API.

2
apis/rivwebcapi/rivwebcapi/Makefile.am
View File

@ -31,6 +31,7 @@ dist_librivwebcapi_la_SOURCES = rd_addcart.c rd_addcart.h \
rd_createticket.c rd_createticket.h \
rd_deleteaudio.c rd_deleteaudio.h \
rd_deletelog.c rd_deletelog.h \
rd_deletepodcast.c rd_deletepodcast.h \
rd_editcart.c rd_editcart.h \
rd_editcut.c rd_editcut.h \
rd_export.c rd_export.h \
@ -81,6 +82,7 @@ include_HEADERS = rd_addcart.h\
rd_cut.h\
rd_deleteaudio.h\
rd_deletelog.h\
rd_deletepodcast.h\
rd_editcart.h\
rd_editcut.h\
rd_export.h\

197
apis/rivwebcapi/rivwebcapi/rd_deletepodcast.c Normal file
View File

@ -0,0 +1,197 @@
/* rd_deletepodcast.c
*
* Implementation of the Remove RSS item audio Rivendell Access Library
*
* (C) Copyright 2015 Todd Baker <bakert@rfa.org>
* (C) Copyright 2020 Fred Gleason <fredg@paravelsystems.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h>
#include <expat.h>
#include "rd_deletepodcast.h"
#include "rd_common.h"
#include "rd_getuseragent.h"
struct xml_data {
char elem_name[256];
char strbuf[1024];
};
static void XMLCALL __DeletePodcastElementStart(void *data, const char *el,
const char **attr)
{
struct xml_data *xml_data=(struct xml_data *)data;
strlcpy(xml_data->elem_name,el,256);
memset(xml_data->strbuf,0,1024);
}
static void XMLCALL __DeletePodcastElementData(void *data,const XML_Char *s,
int len)
{
struct xml_data *xml_data=(struct xml_data *)data;
memcpy(xml_data->strbuf+strlen(xml_data->strbuf),s,len);
}
static void XMLCALL __DeletePodcastElementEnd(void *data, const char *el)
{
struct xml_data *xml_data=(struct xml_data *)data;
}
size_t __DeletePodcastCallback(void *ptr, size_t size, size_t nmemb, void *userdata)
{
XML_Parser p=(XML_Parser)userdata;
XML_Parse(p,ptr,size*nmemb,0);
return size*nmemb;
}
int RD_DeletePodcast( const char hostname[],
const char username[],
const char passwd[],
const char ticket[],
const unsigned cast_id,
const char user_agent[])
{
char post[1500];
char url[1500];
CURL *curl=NULL;
XML_Parser parser;
struct xml_data xml_data;
long response_code;
char errbuf[CURL_ERROR_SIZE];
CURLcode res;
char user_agent_string[255];
char id_buffer[21];
struct curl_httppost *first=NULL;
struct curl_httppost *last=NULL;
if((curl=curl_easy_init())==NULL) {
curl_easy_cleanup(curl);
return -1;
}
/*
* Setup the CURL call
*/
memset(&xml_data,0,sizeof(xml_data));
parser=XML_ParserCreate(NULL);
XML_SetUserData(parser,&xml_data);
XML_SetElementHandler(parser,__DeletePodcastElementStart,
__DeletePodcastElementEnd);
XML_SetCharacterDataHandler(parser,__DeletePodcastElementData);
snprintf(url,1500,"http://%s/rd-bin/rdxport.cgi",hostname);
curl_formadd(&first,
&last,
CURLFORM_PTRNAME,
"COMMAND",
CURLFORM_COPYCONTENTS,
"39",
CURLFORM_END);
curl_formadd(&first,
&last,
CURLFORM_PTRNAME,
"LOGIN_NAME",
CURLFORM_COPYCONTENTS,
username,
CURLFORM_END);
curl_formadd(&first,
&last,
CURLFORM_PTRNAME,
"PASSWORD",
CURLFORM_COPYCONTENTS,
passwd,
CURLFORM_END);
curl_formadd(&first,
&last,
CURLFORM_PTRNAME,
"TICKET",
CURLFORM_COPYCONTENTS,
ticket,
CURLFORM_END);
snprintf(id_buffer,21,"%u",cast_id);
curl_formadd(&first,
&last,
CURLFORM_PTRNAME,
"ID",
CURLFORM_COPYCONTENTS,
id_buffer,
CURLFORM_END);
curl_easy_setopt(curl,CURLOPT_WRITEDATA,parser);
curl_easy_setopt(curl,CURLOPT_WRITEFUNCTION,__DeletePodcastCallback);
curl_easy_setopt(curl,CURLOPT_URL,url);
curl_easy_setopt(curl,CURLOPT_POST,1);
curl_easy_setopt(curl,CURLOPT_HTTPPOST,first);
curl_easy_setopt(curl,CURLOPT_NOPROGRESS,1);
curl_easy_setopt(curl,CURLOPT_ERRORBUFFER,errbuf);
// curl_easy_setopt(curl,CURLOPT_VERBOSE,1);
// Check if User Agent Present otherwise set to default
if (strlen(user_agent)> 0){
curl_easy_setopt(curl, CURLOPT_USERAGENT,user_agent);
}
else
{
strcpy(user_agent_string, RD_GetUserAgent());
strcat(user_agent_string,VERSION);
curl_easy_setopt(curl, CURLOPT_USERAGENT,user_agent_string);
}
res = curl_easy_perform(curl);
if(res != CURLE_OK) {
#ifdef RIVC_DEBUG_OUT
size_t len = strlen(errbuf);
fprintf(stderr, "\nlibcurl error: (%d)", res);
if (len)
fprintf(stderr, "%s%s", errbuf,
((errbuf[len-1] != '\n') ? "\n" : ""));
else
fprintf(stderr, "%s\n", curl_easy_strerror(res));
#endif
curl_formfree(first);
curl_easy_cleanup(curl);
return -1;
}
/* The response OK - so figure out if we got what we wanted.. */
curl_easy_getinfo(curl,CURLINFO_RESPONSE_CODE,&response_code);
curl_formfree(first);
curl_easy_cleanup(curl);
if (response_code > 199 && response_code < 300) { //Success
return 0;
}
else {
#ifdef RIVC_DEBUG_OUT
fprintf(stderr," rd_deletepodcast Call Returned Error: %s\n",xml_data.strbuf);
#endif
return (int)response_code;
}
}

39
apis/rivwebcapi/rivwebcapi/rd_deletepodcast.h Normal file
View File

@ -0,0 +1,39 @@
/* rd_deletepodcast.h
*
* Header for the Delete RSS item audio Rivendell Access Library
*
* (C) Copyright 2015 Todd Baker <bakert@rfa.org>
* (C) Copyright 2020 Fred Gleason <fredg@paravelsystems.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef RD_DELETEPODCAST_H
#define RD_DELETEPODCAST_H
#include <rivwebcapi/rd_common.h>
_MYRIVLIB_INIT_DECL
int RD_DeletePodcast(const char hostname[],
const char username[],
const char passwd[],
const char ticket[],
const unsigned cast_id,
const char user_agent[]);
_MYRIVLIB_FINI_DECL
#endif // RD_DELETEPODCAST_H

8
apis/rivwebcapi/tests/Makefile.am
View File

@ -31,6 +31,7 @@ noinst_PROGRAMS = addcart_test \
createticket_test \
deleteaudio_test \
deletelog_test \
deletepodcast_test \
editcart_test \
editcut_test \
exportcart_test \
@ -55,7 +56,6 @@ noinst_PROGRAMS = addcart_test \
postimage_test \
postpodcast_test \
postrss_test \
postpodcast_test \
removecart_test \
removecut_test \
removeimage_test \
@ -96,6 +96,9 @@ deleteaudio_test_LDADD = -lrivwebcapi -lexpat -lcurl -lm
dist_deletelog_test_SOURCES = deletelog_test.c common.c common.h
deletelog_test_LDADD = -lrivwebcapi -lexpat -lcurl -lm
dist_deletepodcast_test_SOURCES = deletepodcast_test.c common.c common.h
deletepodcast_test_LDADD = -lrivwebcapi -lexpat -lcurl -lm
dist_editcart_test_SOURCES = editcart_test.c
editcart_test_LDADD = -lrivwebcapi -lexpat -lcurl -lm
@ -168,9 +171,6 @@ postpodcast_test_LDADD = -lrivwebcapi -lexpat -lcurl -lm
dist_postrss_test_SOURCES = postrss_test.c
postrss_test_LDADD = -lrivwebcapi -lexpat -lcurl -lm
dist_postpodcast_test_SOURCES = postpodcast_test.c
postpodcast_test_LDADD = -lrivwebcapi -lexpat -lcurl -lm
dist_removecart_test_SOURCES = removecart_test.c
removecart_test_LDADD = -lrivwebcapi -lexpat -lcurl -lm

205
apis/rivwebcapi/tests/deletepodcast_test.c Normal file
View File

@ -0,0 +1,205 @@
/* deletepodcast_test.c
*
* Test the delete podcast library.
*
* (C) Copyright 2020 Fred Gleason <fredg@paravelsystems.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <rivwebcapi/rd_createticket.h>
#include <rivwebcapi/rd_getuseragent.h>
#include <rivwebcapi/rd_getversion.h>
#include <rivwebcapi/rd_deletepodcast.h>
int main(int argc,char *argv[])
{
char buf[BUFSIZ];
char *p;
long int cast_id=0;
char *host;
char *user;
char *passwd;
char ticket[41]="";
char user_agent[255]={0};
/* Get the Rivendell Host, User and Password if set in env */
if (getenv("RIVHOST")!=NULL) {
host = getenv("RIVHOST");
}
else {
host="localhost";
}
if (getenv("RIVUSER")!=NULL) {
user = getenv("RIVUSER");
}
else {
user="USER";
}
if (getenv("RIVPASS")!=NULL) {
passwd = getenv("RIVPASS");
}
else {
passwd = "";
}
printf("Please enter the ID number of the RSS podcast item that you want to delete ==> ");
if (fgets(buf,sizeof(buf),stdin) != NULL)
{
cast_id = strtol(buf, &p,10);
if ( (buf[0] != '\n') &&
((*p != '\n') && (*p != '\0')))
{
fprintf(stderr," Illegal Characters detected! Exiting.\n");
exit(0);
}
}
// Add the User Agent and Version
strcat(user_agent,RD_GetUserAgent());
strcat(user_agent,RD_GetVersion());
strcat(user_agent," (Test Suite)");
//
// Call the function
//
int result=RD_DeletePodcast( host,
user,
passwd,
ticket,
(unsigned)cast_id,
user_agent);
if(result<0) {
fprintf(stderr,"Something went wrong!\n");
exit(256);
}
if ((result< 200 || result > 299) &&
(result != 0))
{
switch(result) {
case 404:
fprintf(stderr,"ERROR: No such podcast exists! \n");
break;
case 401:
fprintf(stderr, "ERROR: Unauthorized \n");
break;
default:
fprintf(stderr, "Unknown Error occurred ==> %d",result);
}
exit(256);
}
//
// List the Results
//
printf(" Podcast item: %ld was successfully deleted!\n",cast_id);
printf("\n");
// Add test of create_ticket function
int i;
struct rd_ticketinfo *myticket=0;
unsigned numrecs=0;
result = RD_CreateTicket( &myticket,
host,
user,
passwd,
user_agent,
&numrecs);
if ((result< 200 || result > 299) &&
(result != 0))
{
switch(result) {
case 403:
fprintf(stderr," ERROR: Invalid User Information During Create Ticket\n");
break;
default:
fprintf(stderr, "Unknown Error occurred ==> %d\n",result);
}
exit(256);
}
// We got a ticket created - use it and do the call again
//
// List the Results
//
for(i=0;i<numrecs;i++) {
printf(" Ticket: %s\n",myticket[i].ticket);
printf("Ticket Expire year value = %d\n",myticket->tkt_expiration_datetime.tm_year);
printf("Ticket Expire month value = %d\n",myticket->tkt_expiration_datetime.tm_mon);
printf("Ticket Expire day value = %d\n",myticket->tkt_expiration_datetime.tm_mday);
printf("Ticket Expire wday value = %d\n",myticket->tkt_expiration_datetime.tm_wday);
printf("Ticket Expire hour value = %d\n",myticket->tkt_expiration_datetime.tm_hour);
printf("Ticket Expire min value = %d\n",myticket->tkt_expiration_datetime.tm_min);
printf("Ticket Expire sec value = %d\n",myticket->tkt_expiration_datetime.tm_sec);
printf("Ticket Expire isdst value = %d\n",myticket->tkt_expiration_datetime.tm_isdst);
printf("\n");
}
user="";
passwd="";
strcpy( ticket,myticket->ticket);
fprintf(stderr, "Ticket was copied - = %s\n",ticket);
//
// Call the function
//
result=RD_DeletePodcast(host,
user,
passwd,
ticket,
(unsigned)cast_id,
user_agent);
if(result<0) {
fprintf(stderr,"Something went wrong!\n");
exit(256);
}
if ((result< 200 || result > 299) &&
(result != 0))
{
switch(result) {
case 404:
fprintf(stderr,"ERROR: No such podcast exists! \n");
break;
case 401:
fprintf(stderr, "ERROR: Unauthorized\n");
break;
default:
fprintf(stderr, "Unknown Error occurred ==> %d",result);
}
exit(256);
}
//
// List the Results
//
printf(" Podcast item: %ld was successfully deleted!\n",cast_id);
printf("\n");
exit(0);
}

8
docs/rivwebcapi/Makefile.am
View File

@ -64,6 +64,9 @@ all-local: rd_addcart.html\
rd_deletelog.html\
rd_deletelog.pdf\
rd_deletelog.xml\
rd_deletepodcast.html\
rd_deletepodcast.pdf\
rd_deletepodcast.xml\
rd_editcart.html\
rd_editcart.pdf\
rd_editcart.xml\
@ -175,6 +178,7 @@ man_MANS = rd_addcart.7\
rd_createticket.7\
rd_deleteaudio.7\
rd_deletelog.7\
rd_deletepodcast.7\
rd_editcart.7\
rd_editcut.7\
rd_exportpeaks.7\
@ -251,6 +255,10 @@ EXTRA_DIST = rd_addcart.7\
rd_deletelog.html\
rd_deletelog.pdf\
rd_deletelog.xml\
rd_deletepodcast.7\
rd_deletepodcast.html\
rd_deletepodcast.pdf\
rd_deletepodcast.xml\
rd_editcart.7\
rd_editcart.html\
rd_editcart.pdf\

188
docs/rivwebcapi/rd_deletepodcast.xml Normal file
View File

@ -0,0 +1,188 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
Header
-->
<refmeta>
<refentrytitle>RD_DeletePodcast</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo class='source'>September 2020</refmiscinfo>
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rd_deletepodcast</refname>
<refpurpose>Rivendell Delete RSS item audio C Library Function</refpurpose>
</refnamediv>
<info>
<author>
<personname>
<firstname>Fred</firstname>
<surname>Gleason</surname>
<email>fredg@paravelsystems.com</email>
</personname>
<contrib>Rivendell C Library Author</contrib>
</author>
</info>
<!--
Body
-->
<refsynopsisdiv id='synopsis'>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;rivwebcapi/rd_deletepodcast.h&gt;</funcsynopsisinfo>
<funcprototype>
<funcdef>int <function>RD_DeletePodcast</function></funcdef>
<paramdef>const char <parameter>hostname[]</parameter></paramdef>
<paramdef>const char <parameter>username[]</parameter></paramdef>
<paramdef>const char <parameter>passwd[]</parameter></paramdef>
<paramdef>const char <parameter>ticket[]</parameter></paramdef>
<paramdef>const unsigned <parameter>cast_id</parameter></paramdef>
<paramdef>const char <parameter>user_agent[]</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id='description'><title>Description</title>
<para>
<command>RD_DeletePodcast</command> is the function to use
to delete RSS item audio from audio store.
</para>
<table xml:id="ex.deletepodcast" frame="all">
<title>RD_DeletePodcast function call fields</title>
<tgroup cols="4" align="left" colsep="1" rowsep="1">
<colspec colname="FIELD NAME" />
<colspec colname="FIELD TYPE" />
<colspec colname="MEANING" />
<colspec colname="REMARKS" />
<thead>
<row>
<entry>
FIELD NAME
</entry>
<entry>
FIELD TYPE
</entry>
<entry>
MEANING
</entry>
<entry>
REMARKS
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
hostname
</entry>
<entry>
Character Array
</entry>
<entry>
Name Of Rivendell DB Host
</entry>
<entry>
Mandatory
</entry>
</row>
<row>
<entry>
username
</entry>
<entry>
Character Array
</entry>
<entry>
Rivendell User Name
</entry>
<entry>
Mandatory When NO Ticket Provided
</entry>
</row>
<row>
<entry>
passwd
</entry>
<entry>
Character Array
</entry>
<entry>
Rivendell User Password
</entry>
<entry>
Mandatory When NO Ticket Provided
</entry>
</row>
<row>
<entry>
ticket
</entry>
<entry>
Character Array
</entry>
<entry>
Rivendell Authentification Ticket
</entry>
<entry>
Mandatory When NO User/Password Pair Provided.
</entry>
</row>
<row>
<entry>
cast_id
</entry>
<entry>
unsigned integer
</entry>
<entry>
Podcast ID
</entry>
<entry>
Mandatory
</entry>
</row>
<row>
<entry>
user_agent
</entry>
<entry>
Character Array
</entry>
<entry>
User Agent Value put into HTTP request
</entry>
<entry>
Optional (default is Rivendell-C-API/x.x.x)
</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect2 id='returns'><title>RETURN VALUE</title>
<para>
On success, zero is returned.
</para>
<para>
If a server error occurs a -1 is returned.
If a client error occurs a specific error number is returned.
</para>
</refsect2>
<refsect3 id='errors'><title>ERRORS</title>
<para>
400 Missing Podcast ID
</para>
<para>
403 User Authentification Error.
</para>
<para>
404 Unauthorized or No Such Podcast
</para>
<para>
nnn Unknown Error Occurred.
</para>
</refsect3>
</refentry>

1
rivendell.spec.in
View File

@ -469,6 +469,7 @@ rm -rf $RPM_BUILD_ROOT
@LOCAL_PREFIX@/share/man/man7/rd_createticket.7.gz
@LOCAL_PREFIX@/share/man/man7/rd_deleteaudio.7.gz
@LOCAL_PREFIX@/share/man/man7/rd_deletelog.7.gz
@LOCAL_PREFIX@/share/man/man7/rd_deletepodcast.7.gz
@LOCAL_PREFIX@/share/man/man7/rd_editcart.7.gz
@LOCAL_PREFIX@/share/man/man7/rd_editcut.7.gz
@LOCAL_PREFIX@/share/man/man7/rd_export.7.gz