diff --git a/ChangeLog b/ChangeLog index 9db5468e..6eb2a075 100644 --- a/ChangeLog +++ b/ChangeLog @@ -22713,3 +22713,5 @@ containing the cart and cut numbers of the import destination. 2021-12-08 Fred Gleason * Added a 'LockLog()' method to the 'rivwebpyapi' API. +2021-12-08 Fred Gleason + * Added a 'Rehash()' method to the 'rivwebpyapi' API. diff --git a/apis/rivwebpyapi/api/rivwebpyapi.py b/apis/rivwebpyapi/api/rivwebpyapi.py index bf038db3..32cfcec9 100755 --- a/apis/rivwebpyapi/api/rivwebpyapi.py +++ b/apis/rivwebpyapi/api/rivwebpyapi.py @@ -1651,6 +1651,9 @@ class rivwebpyapi(object): operation - The operation to perform. Valid values are 'CREATE', 'UPDATE' and 'CLEAR'. + + guid - The Globally Unique IDentifier for an existing log. + Need only for the 'UPDATE' and 'CLEAR' operations (string). """ if(not log_name): @@ -1693,23 +1696,41 @@ class rivwebpyapi(object): return handler.output()[0] + def Rehash(self,cart_number,cut_number): + """ + Update the SHA1 hash entry in the database from the contents of + the audio store. + Takes the following arguments: + cart_number - The number of the desired cart, in the range + 1 - 999999 (integer) + cut_number - The number of the desired cut, in the range + 1 - 999 (integer) + """ + if((cart_number<1)or(cart_number>999999)): + raise ValueError('invalid cart number') + if((cut_number<1)or(cut_number>999)): + raise ValueError('invalid cut number') + # + # Build the WebAPI arguments + # + postdata={ + 'COMMAND': '32', + 'LOGIN_NAME': self.__connection_username, + 'PASSWORD': self.__connection_password, + 'CART_NUMBER': str(cart_number), + 'CUT_NUMBER': str(cut_number) + } - - - - - - - - - - - - + # + # Fetch the XML + # + r=requests.post(self.__connection_url,data=postdata) + if(r.status_code!=requests.codes.ok): + self.__throwError(response=r) def RemoveCart(self,cart_number): """ diff --git a/apis/rivwebpyapi/tests/Makefile.am b/apis/rivwebpyapi/tests/Makefile.am index 9d5f4f20..c0ce8a61 100644 --- a/apis/rivwebpyapi/tests/Makefile.am +++ b/apis/rivwebpyapi/tests/Makefile.am @@ -44,6 +44,7 @@ EXTRA_DIST = add_cart.py\ list_services.py\ list_system_settings.py\ lock_log.py\ + rehash.py\ remove_cart.py\ remove_cut.py\ unassign_sched_code.py diff --git a/apis/rivwebpyapi/tests/rehash.py b/apis/rivwebpyapi/tests/rehash.py new file mode 100755 index 00000000..62669081 --- /dev/null +++ b/apis/rivwebpyapi/tests/rehash.py @@ -0,0 +1,79 @@ +#!%PYTHON_BANGPATH% + +# rehash.py +# +# RivWebPyApi test script for Rivendell +# +# Test the Rehash Web API call +# +# (C) Copyright 2021 Fred Gleason +# +# 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. +# + +import getpass +import rivwebpyapi +import sys +def eprint(*args,**kwargs): + print(*args,file=sys.stderr,**kwargs) + +url=''; +username='' +password='' +cart_number=0 +cut_number=0 + +# +# Get login parameters +# +usage='rehash.py --url= --username= --cart-number= --cut-number= [--password=]' +for arg in sys.argv: + f0=arg.split('=') + if(len(f0)==2): + if(f0[0]=='--url'): + url=f0[1] + if(f0[0]=='--username'): + username=f0[1] + if(f0[0]=='--password'): + password=f0[1] + if(f0[0]=='--cart-number'): + cart_number=int(f0[1]) + if(f0[0]=='--cut-number'): + cut_number=int(f0[1]) + +if(not password): + password=getpass.getpass() +if((not url)or(not username)): + print(usage) + sys.exit(1) +if(cart_number==0): + eprint('you must supply "--cart-number"') + sys.exit(1) +if(cut_number==0): + eprint('you must supply "--cut-number"') + sys.exit(1) + +# +# Execute +# +webapi=rivwebpyapi.rivwebpyapi(url=url,username=username,password=password) +try: + webapi.Rehash(cart_number=cart_number,cut_number=cut_number) +except rivwebpyapi.RivWebPyError as err: + eprint('*** ERROR ***') + eprint('Response Code: '+str(err.responseCode)) + eprint('ErrorString: '+str(err.errorString)) + eprint('*************') + eprint('') + sys.exit(1)