2018-10-10 Fred Gleason <fredg@paravelsystems.com>

* Added an 'RD_ListCartCuts()' function to 'rivwebcapi'.
	* Changed the length of the 'cut_name' member of the 'rd_cut' struct
	from 11 to 41 in 'rivwebcapi'.
	* Added a 'struct rd_cut *cart_cuts' member to the 'rd_cart' struct
	in 'rivwebcapi'.

apis/rivwebcapi/rivwebcapi/Makefile.am

@@ -40,6 +40,7 @@ dist_librivwebcapi_la_SOURCES = rd_addcart.c rd_addcart.h \
 				rd_import.c rd_import.h \
 				rd_listcartschedcodes.c rd_listcartschedcodes.h\
 				rd_listcart.c rd_listcart.h \
+				rd_listcartcuts.c rd_listcartcuts.h \
 				rd_listcarts.c rd_listcarts.h \
 				rd_listcut.c rd_listcut.h \
 				rd_listcuts.c rd_listcuts.h \
@@ -81,6 +82,7 @@ include_HEADERS = rd_addcart.h\
                   rd_group.h\
                   rd_import.h\
                   rd_listcart.h\
+                  rd_listcartcuts.h\
                   rd_listcartschedcodes.h\
                   rd_listcarts.h\
                   rd_listcut.h\

apis/rivwebcapi/rivwebcapi/rd_cart.h

@@ -16,6 +16,8 @@
 
 #include <time.h>
 
+#include <rivwebcapi/rd_cut.h>
+
 enum CART_TYPE {TYPE_ALL,TYPE_AUDIO,TYPE_MACRO};
 
 struct rd_cart {
@@ -39,7 +41,6 @@ struct rd_cart {
   int  cart_length_deviation;
   int  cart_average_segue_length;
   int  cart_average_hook_length;
-  unsigned  cart_cut_quantity;
   unsigned  cart_last_cut_played;
   unsigned  cart_validity;
   int cart_enforce_length;
@@ -47,6 +48,8 @@ struct rd_cart {
   char cart_owner[257];  
   char cart_notes[4096];
   struct tm cart_metadata_datetime;
+  unsigned  cart_cut_quantity;
+  struct rd_cut **cart_cuts;
 };                      
 
 

apis/rivwebcapi/rivwebcapi/rd_cut.h

@@ -24,7 +24,7 @@
 #include <time.h>
 
 struct rd_cut {
-  char cut_name[11];
+  char cut_name[41];
   unsigned cut_cart_number;
   unsigned cut_cut_number;
   int cut_evergreen;

apis/rivwebcapi/rivwebcapi/rd_listcartcuts.c

@@ -0,0 +1,482 @@
+/* rd_listcartcuts.c
+ *
+ * Implementation of the ListCartCuts Rivendell Access Library
+ *
+ * (C) Copyright 2015 Todd Baker  <bakert@rfa.org>             
+ * (C) Copyright 2018 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_common.h"
+#include "rd_getuseragent.h"
+#include "rd_listcart.h"
+
+struct xml_data {
+  char elem_name[256];
+  char strbuf[1024];
+  struct rd_cart *carts;
+  int cut_ptr;
+};
+
+
+static void XMLCALL __ListCartCutsElementStart(void *data, const char *el, 
+					     const char **attr)
+{
+  unsigned i;
+  struct xml_data *xml_data=(struct xml_data *)data;
+  if(strcasecmp(el,"cart")==0) {    // Allocate a new cart entry
+    xml_data->carts=realloc(xml_data->carts, sizeof(struct rd_cart));
+    memset(xml_data->carts,0,sizeof(struct rd_cart));
+    xml_data->cut_ptr=-1;
+  }
+  if(strcasecmp(el,"cut")==0) {    // Allocate a new cut entry
+    (xml_data->cut_ptr)++;
+    xml_data->carts->cart_cuts=realloc(xml_data->carts->cart_cuts,sizeof(struct rd_cut)*((xml_data->cut_ptr)+1));
+  }
+  strlcpy(xml_data->elem_name,el,256);
+  memset(xml_data->strbuf,0,1024);
+}
+
+
+static void XMLCALL __ListCartCutsElementData(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 __ListCartCutsElementEnd(void *data, const char *el)
+{
+  struct xml_data *xml_data=(struct xml_data *)data;
+  struct rd_cart *carts=xml_data->carts;
+  char hold_datetime[27];
+
+  if(xml_data->cut_ptr<0) {
+    /*
+     * Cart Attributes
+     */
+    if(strcasecmp(el,"number")==0) {
+      sscanf(xml_data->strbuf,"%u",&carts->cart_number);
+    }
+    if(strcasecmp(el,"type")==0) {
+      if(strcasecmp(xml_data->strbuf,"audio")==0) {
+	carts->cart_type=TYPE_AUDIO;
+      }
+      else {
+	if(strcasecmp(xml_data->strbuf,"macro")==0) {
+	  carts->cart_type=TYPE_MACRO;
+	}
+	else
+	  {
+	    /*  This is ALL type */
+	    carts->cart_type=TYPE_ALL;
+	  }
+      }
+    }
+
+    if(strcasecmp(el,"groupName")==0) {
+      strlcpy(carts->cart_grp_name,xml_data->strbuf,41);
+    }
+    if(strcasecmp(el,"title")==0) {
+      strlcpy(carts->cart_title,xml_data->strbuf,1021);
+    }
+    if(strcasecmp(el,"artist")==0) {
+      strlcpy(carts->cart_artist,xml_data->strbuf,1021);
+    }
+    if(strcasecmp(el,"album")==0) {
+      strlcpy(carts->cart_album,xml_data->strbuf,1021);
+    }
+    if(strcasecmp(el,"year")==0) {
+      sscanf(xml_data->strbuf,"%d",&carts->cart_year);
+    }
+    if(strcasecmp(el,"label")==0) {
+      strlcpy(carts->cart_label,xml_data->strbuf,257);
+    }
+    if(strcasecmp(el,"client")==0) {
+      strlcpy(carts->cart_client,xml_data->strbuf,257);
+    }
+    if(strcasecmp(el,"agency")==0) {
+      strlcpy(carts->cart_agency,xml_data->strbuf,257);
+    }
+    if(strcasecmp(el,"publisher")==0) {
+      strlcpy(carts->cart_publisher,xml_data->strbuf,257);
+    }
+    if(strcasecmp(el,"composer")==0) {
+      strlcpy(carts->cart_composer,xml_data->strbuf,257);
+    }
+    if(strcasecmp(el,"conductor")==0) {
+      strlcpy(carts->cart_conductor,xml_data->strbuf,257);
+    }
+    if(strcasecmp(el,"userDefined")==0) {
+      strlcpy(carts->cart_user_defined,xml_data->strbuf,1021);
+    }
+    if(strcasecmp(el,"usageCode")==0) {
+      sscanf(xml_data->strbuf,"%d",&carts->cart_usage_code);
+    }
+    if(strcasecmp(el,"forcedLength")==0) {
+      carts->cart_forced_length=RD_Cnv_TString_to_msec(xml_data->strbuf);
+    }
+    if(strcasecmp(el,"averageLength")==0) {
+      carts->cart_average_length=RD_Cnv_TString_to_msec(xml_data->strbuf);
+    }
+    if(strcasecmp(el,"lengthDeviation")==0) {
+      carts->cart_length_deviation=RD_Cnv_TString_to_msec(xml_data->strbuf);
+    }
+    if(strcasecmp(el,"averageSegueLength")==0) {
+      carts->cart_average_segue_length=RD_Cnv_TString_to_msec(xml_data->strbuf);
+    }
+    if(strcasecmp(el,"averageHookLength")==0) {
+      carts->cart_average_hook_length=RD_Cnv_TString_to_msec(xml_data->strbuf);
+    }
+    if(strcasecmp(el,"cutQuantity")==0) {
+      sscanf(xml_data->strbuf,"%u",&carts->cart_cut_quantity);
+    }
+    if(strcasecmp(el,"lastCutPlayed")==0) {
+      sscanf(xml_data->strbuf,"%u",&carts->cart_last_cut_played);
+    }
+    if(strcasecmp(el,"validity")==0) {
+      sscanf(xml_data->strbuf,"%u",&carts->cart_validity);
+    }
+    if(strcasecmp(el,"enforceLength")==0) {
+      carts->cart_enforce_length=RD_ReadBool(xml_data->strbuf);
+    }
+    if(strcasecmp(el,"asyncronous")==0) {
+      carts->cart_asyncronous=RD_ReadBool(xml_data->strbuf);
+    }
+    if(strcasecmp(el,"owner")==0) {
+      strlcpy(carts->cart_owner,xml_data->strbuf,257);
+    }
+    if(strcasecmp(el,"metadataDatetime")==0) {
+      strlcpy(hold_datetime,xml_data->strbuf,26);
+      carts->cart_metadata_datetime = RD_Cnv_DTString_to_tm(hold_datetime);
+    }
+  }
+  else {
+    /*
+     * Cut Attributes
+     */
+    struct rd_cut *cut=(struct rd_cut *)(carts->cart_cuts)+xml_data->cut_ptr;
+
+    if(strcasecmp(el,"cutName")==0) {
+      strlcpy(cut->cut_name,xml_data->strbuf,40);
+    }
+    if(strcasecmp(el,"cartNumber")==0) {
+      sscanf(xml_data->strbuf,"%u",&(cut->cut_cart_number));
+    }
+    if(strcasecmp(el,"cutNumber")==0) {
+      sscanf(xml_data->strbuf,"%u",&(cut->cut_cut_number));
+    }
+    if(strcasecmp(el,"evergreen")==0) {
+      cut->cut_evergreen=strcmp(xml_data->strbuf,"false");
+    }
+    if(strcasecmp(el,"description")==0) {
+      strlcpy(cut->cut_description,xml_data->strbuf,256);
+    }
+    if(strcasecmp(el,"outcue")==0) {
+      strlcpy(cut->cut_outcue,xml_data->strbuf,256);
+    }
+    if(strcasecmp(el,"isrc")==0) {
+      strlcpy(cut->cut_isrc,xml_data->strbuf,48);
+    }
+    if(strcasecmp(el,"isci")==0) {
+      strlcpy(cut->cut_isci,xml_data->strbuf,128);
+    }
+    if(strcasecmp(el,"length")==0) {
+      sscanf(xml_data->strbuf,"%u",&(cut->cut_length));
+    }
+    if(strcasecmp(el,"originDatetime")==0) {
+      strlcpy(hold_datetime,xml_data->strbuf,26);
+      cut->cut_origin_datetime=RD_Cnv_DTString_to_tm(hold_datetime);
+    }
+    if(strcasecmp(el,"startDatetime")==0) {
+      strlcpy(hold_datetime,xml_data->strbuf,26);
+      cut->cut_start_datetime=RD_Cnv_DTString_to_tm(hold_datetime);
+    }
+    if(strcasecmp(el,"endDatetime")==0) {
+      strlcpy(hold_datetime,xml_data->strbuf,26);
+      cut->cut_end_datetime=RD_Cnv_DTString_to_tm(hold_datetime);
+    }
+    if(strcasecmp(el,"sun")==0) {
+      cut->cut_sun=strcmp(xml_data->strbuf,"false");
+    }
+    if(strcasecmp(el,"mon")==0) {
+      cut->cut_mon=strcmp(xml_data->strbuf,"false");
+    }
+    if(strcasecmp(el,"tue")==0) {
+      cut->cut_tue=strcmp(xml_data->strbuf,"false");
+    }
+    if(strcasecmp(el,"wed")==0) {
+      cut->cut_wed=strcmp(xml_data->strbuf,"false");
+    }
+    if(strcasecmp(el,"thu")==0) {
+      cut->cut_thu=strcmp(xml_data->strbuf,"false");
+    }
+    if(strcasecmp(el,"fri")==0) {
+      cut->cut_fri=strcmp(xml_data->strbuf,"false");
+    }
+    if(strcasecmp(el,"sat")==0) {
+      cut->cut_sat=strcmp(xml_data->strbuf,"false");
+    }
+    if(strcasecmp(el,"startDaypart")==0) {
+      strlcpy(cut->cut_start_daypart,xml_data->strbuf,14);
+    }
+    if(strcasecmp(el,"endDaypart")==0) {
+      strlcpy(cut->cut_end_daypart,xml_data->strbuf,14);
+    }
+    if(strcasecmp(el,"originName")==0) {
+      strlcpy(cut->cut_origin_name,xml_data->strbuf,256);
+    }
+    if(strcasecmp(el,"originLoginName")==0) {
+      strlcpy(cut->cut_origin_login_name,xml_data->strbuf,764);
+    }
+    if(strcasecmp(el,"sourceHostname")==0) {
+      strlcpy(cut->cut_source_hostname,xml_data->strbuf,764);
+    }
+    if(strcasecmp(el,"weight")==0) {
+      sscanf(xml_data->strbuf,"%u",&(cut->cut_weight));
+    }
+    if(strcasecmp(el,"lastPlayDatetime")==0) {
+      strlcpy(hold_datetime,xml_data->strbuf,26);
+      cut->cut_last_play_datetime=RD_Cnv_DTString_to_tm(hold_datetime);
+    }
+    if(strcasecmp(el,"playCounter")==0) {
+      sscanf(xml_data->strbuf,"%u",&(cut->cut_play_counter));
+    }
+    if(strcasecmp(el,"codingFormat")==0) {
+      sscanf(xml_data->strbuf,"%u",&(cut->cut_coding_format));
+    }
+    if(strcasecmp(el,"sampleRate")==0) {
+      sscanf(xml_data->strbuf,"%u",&(cut->cut_sample_rate));
+    }
+    if(strcasecmp(el,"bitRate")==0) {
+      sscanf(xml_data->strbuf,"%u",&(cut->cut_bit_rate));
+    }
+    if(strcasecmp(el,"channels")==0) {
+      sscanf(xml_data->strbuf,"%u",&(cut->cut_channels));
+    }
+    if(strcasecmp(el,"playGain")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_play_gain));
+    }
+    if(strcasecmp(el,"startPoint")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_start_point));
+    }
+    if(strcasecmp(el,"endPoint")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_end_point));
+    }
+    if(strcasecmp(el,"fadeupPoint")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_fadeup_point));
+    }
+    if(strcasecmp(el,"fadedownPoint")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_fadedown_point));
+    }
+    if(strcasecmp(el,"segueStartPoint")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_segue_start_point));
+    }
+    if(strcasecmp(el,"segueEndPoint")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_segue_end_point));
+    }
+    if(strcasecmp(el,"segueGain")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_segue_gain));
+    }
+    if(strcasecmp(el,"hookStartPoint")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_hook_start_point));
+    }
+    if(strcasecmp(el,"hookEndPoint")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_hook_end_point));
+    }
+    if(strcasecmp(el,"talkStartPoint")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_talk_start_point));
+    }
+    if(strcasecmp(el,"talkEndPoint")==0) {
+      sscanf(xml_data->strbuf,"%d",&(cut->cut_talk_end_point));
+    }
+  }
+}
+
+
+size_t __ListCartCutsCallback(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_ListCartCuts(struct rd_cart *carts[],
+		    const char hostname[],
+		    const char username[],
+		    const char passwd[],
+		    const char ticket[],
+		    const unsigned cartnumber,
+		    const char user_agent[],
+		    unsigned *numrecs)
+{
+  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 cart_buffer[7];
+  struct curl_httppost *first=NULL;
+  struct curl_httppost *last=NULL;
+
+  /*  Set number of recs so if fail already set */
+  *numrecs = 0;
+  
+  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,__ListCartCutsElementStart,
+			__ListCartCutsElementEnd);
+  XML_SetCharacterDataHandler(parser,__ListCartCutsElementData);
+  snprintf(url,1500,"http://%s/rd-bin/rdxport.cgi",hostname);
+
+  curl_formadd(&first,
+	&last,
+	CURLFORM_PTRNAME,
+	"COMMAND",
+        CURLFORM_COPYCONTENTS,
+        "7",
+        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(cart_buffer,7,"%u",cartnumber);
+  curl_formadd(&first,
+	&last,
+	CURLFORM_PTRNAME,
+	"CART_NUMBER",
+        CURLFORM_COPYCONTENTS, 
+	cart_buffer,
+	CURLFORM_END);
+
+  curl_formadd(&first,
+	&last,
+	CURLFORM_PTRNAME,
+	"INCLUDE_CUTS",
+        CURLFORM_PTRCONTENTS, 
+	"1",
+	CURLFORM_END);
+
+  curl_easy_setopt(curl,CURLOPT_WRITEDATA,parser);
+  curl_easy_setopt(curl,CURLOPT_WRITEFUNCTION,__ListCartCutsCallback);
+  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);
+
+  // 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_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) {
+    *carts=xml_data.carts;
+    *numrecs = 1;
+    return 0;
+  }
+  else {
+    #ifdef RIVC_DEBUG_OUT
+        fprintf(stderr," rd_listcart Call Returned Error: %s\n",xml_data.strbuf);
+    #endif
+    return (int)response_code;
+  }
+}
+
+
+struct rd_cut *RD_ListCartCuts_GetCut(struct rd_cart *cart,int pos)
+{
+  return (struct rd_cut *)(cart->cart_cuts)+pos;
+}
+
+
+void RD_ListCartCuts_Free(struct rd_cart *cart)
+{
+  if(cart->cart_cuts!=NULL) {
+    free(cart->cart_cuts);
+  }
+  free(cart);
+}

apis/rivwebcapi/rivwebcapi/rd_listcartcuts.h

@@ -0,0 +1,45 @@
+/* rd_listcartcuts.h
+ *
+ * Header for the ListCartCuts  Rivendell Access Library
+ *
+ * (C) Copyright 2015 Todd Baker  <bakert@rfa.org>
+ * (C) Copyright 2018 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_LISTCARTCUTS_H
+#define RD_LISTCARTCUTS_H
+
+#include <rivwebcapi/rd_common.h>
+
+_MYRIVLIB_INIT_DECL
+
+#include <rivwebcapi/rd_cart.h>
+
+int RD_ListCartCuts(struct rd_cart *carts[],
+		    const char hostname[],
+		    const char username[],
+		    const char passwd[],
+		    const char ticket[],
+		    const unsigned cartnumber,
+		    const char user_agent[],
+		    unsigned *numrecs);
+struct rd_cut *RD_ListCartCuts_GetCut(struct rd_cart *cart,int pos);
+void RD_ListCartCuts_Free(struct rd_cart *cart);
+
+_MYRIVLIB_FINI_DECL
+
+
+#endif  // RD_LISTCARTCUTS_H