new api class + documentation

Author: RaNaN

Diff for: module/Api.py

@@ -176,7 +176,6 @@ def toDbDict(self):
             }
         }
 
-    @lock
     def abortDownload(self):
         """abort pyfile if possible"""
         while self.id in self.m.core.threadManager.processingIds():
@@ -186,8 +185,9 @@ def abortDownload(self):
             sleep(0.1)
 
         self.abort = False
-        if hasattr(self, "plugin") and self.plugin and self.plugin.req:
+        if self.hasPlugin() and self.plugin.req:
             self.plugin.req.abortDownloads()
+
         self.release()
 
     def finishIfDone(self):

Diff for: module/PyFile.py

@@ -24,13 +24,13 @@
 from Handler import Handler
 from printer import *
 
-from module.remote.thriftbackend.thriftgen.pyload.Pyload import PackageData, PackageDoesNotExists
+from module.Api import Destination, PackageData
 
 class ManageFiles(Handler):
     """ possibility to manage queue/collector """
 
     def init(self):
-        self.target = 1 #queue and collector are swapped
+        self.target = Destination.Queue
         self.pos = 0    #position in queue
         self.package = -1  #choosen package
         self.mode = ""   # move/delete/restart
@@ -155,7 +155,7 @@ def getPackages(self):
         if self.cache and self.time + 2 < time():
             return self.cache
 
-        if self.target == 1:
+        if self.target == Destination.Queue:
             data = self.client.getQueue()
         else:
             data = self.client.getCollector()

Diff for: module/cli/ManageFiles.py

@@ -19,7 +19,6 @@
 
 from module.remote.RemoteManager import BackendBase
 
-from thriftbackend.Handler import Handler
 from thriftbackend.Processor import Processor
 from thriftbackend.Protocol import ProtocolFactory
 from thriftbackend.Socket import ServerSocket
@@ -30,8 +29,7 @@
 
 class ThriftBackend(BackendBase):
     def setup(self, host, port):
-        handler = Handler(self)
-        processor = Processor(handler)
+        processor = Processor(self.core.api)
 
         key = None
         cert = None

Diff for: module/remote/ThriftBackend.py

@@ -34,7 +34,7 @@ def _convertConfigFormat(self, c):
                 item = ConfigItem()
                 item.name = key
                 item.description = data["desc"]
-                item.value = str(data["value"]) if type(data["value"]) not in (str, unicode) else data["value"]
+                item.value = str(data["value"]) if type(data["value"]) != basestring else data["value"]
                 item.type = data["type"]
                 items.append(item)
             section.items = items
@@ -59,7 +59,7 @@ def setConfigValue(self, category, option, value, section):
          - value
          - section
         """
-        self.serverMethods.set_conf_val(category, option, value, section)
+        pass
 
     def getConfig(self):
         c = self.serverMethods.get_config()

Diff for: module/remote/thriftbackend/Handler.py

@@ -29,8 +29,8 @@ enum DownloadStatus {
 }
 
 enum Destination {
-  Queue,
-  Collector
+  Collector,
+  Queue
 }
 
 enum ElementType {
@@ -62,7 +62,7 @@ struct ServerStatus {
   2: i16 active,
   3: i16 queue,
   4: i16 total,
-  5: i32 speed,
+  5: i64 speed,
   6: bool download,
   7: bool reconnect
 }
@@ -104,19 +104,8 @@ struct PackageData {
   6: Destination dest,
   7: i16 order,
   8: Priority priority,
-  9: list<FileData> links
-}
-
-struct PackageInfo {
-  1: PackageID pid,
-  2: string name,
-  3: string folder,
-  4: string site,
-  5: string password,
-  6: Destination dest,
-  7: i16 order,
-  8: Priority priority,
-  9: list<FileID> links
+  9: optional list<FileID> fids,
+  10: optional list<FileData> links
 }
 
 struct CaptchaTask {
@@ -221,18 +210,26 @@ service Pyload {
   ResultID checkOnlineStatus(1: LinkList urls),
   map<PluginName, list<OnlineStatus>> pollResults(1: ResultID rid),
 
-  //downloads
+  // downloads - information
   list<DownloadInfo> statusDownloads(),
-  PackageID addPackage(1: string name, 2: LinkList links, 3: Destination dest),
   PackageData getPackageData(1: PackageID pid) throws (1: PackageDoesNotExists e),
+  PackageData getPackageInfo(1: PackageID pid) throws (1: PackageDoesNotExists e),
   FileData getFileData(1: FileID fid) throws (1: FileDoesNotExists e),
-  void deleteFiles(1: list<FileID> fids),
-  void deletePackages(1: list<PackageID> pids),
-  list<PackageInfo> getQueue(),
-  list<PackageInfo> getCollector(),
+  list<PackageData> getQueue(),
+  list<PackageData> getCollector(),
   list<PackageData> getQueueData(),
   list<PackageData> getCollectorData(),
+  map<i16, PackageID> getPackageOrder(1: Destination destination),
+  map<i16, FileID> getFileOrder(1: PackageID pid)
+
+  // downloads - adding/deleting
+  PackageID addPackage(1: string name, 2: LinkList links, 3: Destination dest),
   void addFiles(1: PackageID pid, 2: LinkList links),
+  void uploadContainer(1: string filename, 2: binary data),
+  void deleteFiles(1: list<FileID> fids),
+  void deletePackages(1: list<PackageID> pids),
+
+  // downloads - modifying
   void pushToQueue(1: PackageID pid),
   void pullFromQueue(1: PackageID pid),
   void restartPackage(1: PackageID pid),
@@ -242,15 +239,13 @@ service Pyload {
   void stopDownloads(1: list<FileID> fids),
   void setPackageName(1: PackageID pid, 2: string name),
   void movePackage(1: Destination destination, 2: PackageID pid),
-  void uploadContainer(1: string filename, 2: binary data),
   void setPriority(1: PackageID pid, 2: Priority priority)
   void orderPackage(1: PackageID pid, 2: i16 position),
   void orderFile(1: FileID fid, 2: i16 position),
-  void setPackageData(1: PackageID pid, 2: map<string, string> data),
+  void setPackageData(1: PackageID pid, 2: map<string, string> data) throws (1: PackageDoesNotExists e),
   void deleteFinished(),
   void restartFailed(),
-  map<i16, PackageID> getPackageOrder(1: Destination destination),
-  map<i16, FileID> getFileOrder(1: PackageID pid)
+
 
   //captcha
   bool isCaptchaWaiting(),

Diff for: module/remote/thriftbackend/pyload.thrift

@@ -44,16 +44,20 @@ if len(sys.argv) <= 1 or sys.argv[1] == '--help':
   print '  ResultID checkOnlineStatus(LinkList urls)'
   print '   pollResults(ResultID rid)'
   print '   statusDownloads()'
-  print '  PackageID addPackage(string name, LinkList links, Destination dest)'
   print '  PackageData getPackageData(PackageID pid)'
+  print '  PackageData getPackageInfo(PackageID pid)'
   print '  FileData getFileData(FileID fid)'
-  print '  void deleteFiles( fids)'
-  print '  void deletePackages( pids)'
   print '   getQueue()'
   print '   getCollector()'
   print '   getQueueData()'
   print '   getCollectorData()'
+  print '   getPackageOrder(Destination destination)'
+  print '   getFileOrder(PackageID pid)'
+  print '  PackageID addPackage(string name, LinkList links, Destination dest)'
   print '  void addFiles(PackageID pid, LinkList links)'
+  print '  void uploadContainer(string filename, string data)'
+  print '  void deleteFiles( fids)'
+  print '  void deletePackages( pids)'
   print '  void pushToQueue(PackageID pid)'
   print '  void pullFromQueue(PackageID pid)'
   print '  void restartPackage(PackageID pid)'
@@ -63,15 +67,12 @@ if len(sys.argv) <= 1 or sys.argv[1] == '--help':
   print '  void stopDownloads( fids)'
   print '  void setPackageName(PackageID pid, string name)'
   print '  void movePackage(Destination destination, PackageID pid)'
-  print '  void uploadContainer(string filename, string data)'
   print '  void setPriority(PackageID pid, Priority priority)'
   print '  void orderPackage(PackageID pid, i16 position)'
   print '  void orderFile(FileID fid, i16 position)'
   print '  void setPackageData(PackageID pid,  data)'
   print '  void deleteFinished()'
   print '  void restartFailed()'
-  print '   getPackageOrder(Destination destination)'
-  print '   getFileOrder(PackageID pid)'
   print '  bool isCaptchaWaiting()'
   print '  CaptchaTask getCaptchaTask(bool exclusive)'
   print '  string getCaptchaTaskStatus(TaskID tid)'
@@ -264,35 +265,23 @@ elif cmd == 'statusDownloads':
     sys.exit(1)
   pp.pprint(client.statusDownloads())
 
-elif cmd == 'addPackage':
-  if len(args) != 3:
-    print 'addPackage requires 3 args'
-    sys.exit(1)
-  pp.pprint(client.addPackage(args[0],eval(args[1]),eval(args[2]),))
-
 elif cmd == 'getPackageData':
   if len(args) != 1:
     print 'getPackageData requires 1 args'
     sys.exit(1)
   pp.pprint(client.getPackageData(eval(args[0]),))
 
-elif cmd == 'getFileData':
-  if len(args) != 1:
-    print 'getFileData requires 1 args'
-    sys.exit(1)
-  pp.pprint(client.getFileData(eval(args[0]),))
-
-elif cmd == 'deleteFiles':
+elif cmd == 'getPackageInfo':
   if len(args) != 1:
-    print 'deleteFiles requires 1 args'
+    print 'getPackageInfo requires 1 args'
     sys.exit(1)
-  pp.pprint(client.deleteFiles(eval(args[0]),))
+  pp.pprint(client.getPackageInfo(eval(args[0]),))
 
-elif cmd == 'deletePackages':
+elif cmd == 'getFileData':
   if len(args) != 1:
-    print 'deletePackages requires 1 args'
+    print 'getFileData requires 1 args'
     sys.exit(1)
-  pp.pprint(client.deletePackages(eval(args[0]),))
+  pp.pprint(client.getFileData(eval(args[0]),))
 
 elif cmd == 'getQueue':
   if len(args) != 0:
@@ -318,12 +307,48 @@ elif cmd == 'getCollectorData':
     sys.exit(1)
   pp.pprint(client.getCollectorData())
 
+elif cmd == 'getPackageOrder':
+  if len(args) != 1:
+    print 'getPackageOrder requires 1 args'
+    sys.exit(1)
+  pp.pprint(client.getPackageOrder(eval(args[0]),))
+
+elif cmd == 'getFileOrder':
+  if len(args) != 1:
+    print 'getFileOrder requires 1 args'
+    sys.exit(1)
+  pp.pprint(client.getFileOrder(eval(args[0]),))
+
+elif cmd == 'addPackage':
+  if len(args) != 3:
+    print 'addPackage requires 3 args'
+    sys.exit(1)
+  pp.pprint(client.addPackage(args[0],eval(args[1]),eval(args[2]),))
+
 elif cmd == 'addFiles':
   if len(args) != 2:
     print 'addFiles requires 2 args'
     sys.exit(1)
   pp.pprint(client.addFiles(eval(args[0]),eval(args[1]),))
 
+elif cmd == 'uploadContainer':
+  if len(args) != 2:
+    print 'uploadContainer requires 2 args'
+    sys.exit(1)
+  pp.pprint(client.uploadContainer(args[0],args[1],))
+
+elif cmd == 'deleteFiles':
+  if len(args) != 1:
+    print 'deleteFiles requires 1 args'
+    sys.exit(1)
+  pp.pprint(client.deleteFiles(eval(args[0]),))
+
+elif cmd == 'deletePackages':
+  if len(args) != 1:
+    print 'deletePackages requires 1 args'
+    sys.exit(1)
+  pp.pprint(client.deletePackages(eval(args[0]),))
+
 elif cmd == 'pushToQueue':
   if len(args) != 1:
     print 'pushToQueue requires 1 args'
@@ -378,12 +403,6 @@ elif cmd == 'movePackage':
     sys.exit(1)
   pp.pprint(client.movePackage(eval(args[0]),eval(args[1]),))
 
-elif cmd == 'uploadContainer':
-  if len(args) != 2:
-    print 'uploadContainer requires 2 args'
-    sys.exit(1)
-  pp.pprint(client.uploadContainer(args[0],args[1],))
-
 elif cmd == 'setPriority':
   if len(args) != 2:
     print 'setPriority requires 2 args'
@@ -420,18 +439,6 @@ elif cmd == 'restartFailed':
     sys.exit(1)
   pp.pprint(client.restartFailed())
 
-elif cmd == 'getPackageOrder':
-  if len(args) != 1:
-    print 'getPackageOrder requires 1 args'
-    sys.exit(1)
-  pp.pprint(client.getPackageOrder(eval(args[0]),))
-
-elif cmd == 'getFileOrder':
-  if len(args) != 1:
-    print 'getFileOrder requires 1 args'
-    sys.exit(1)
-  pp.pprint(client.getFileOrder(eval(args[0]),))
-
 elif cmd == 'isCaptchaWaiting':
   if len(args) != 0:
     print 'isCaptchaWaiting requires 0 args'