Merge lp:~mycompostpile/cairo-dock-plug-ins-extras/YoutubeDl into lp:~cairo-dock-team/cairo-dock-plug-ins-extras/third-party

[Brian]

Added middle click selection to show up in the right click menu.

Cleaned up the handbook.

Added clipboard entry on right click if there appears to be a youtube url.
Also on left click when the list is empty added the default string to be the clipboard contents if there appears to be a youtube url.

Change the tab in the configuration file to read Configuration instead of User Interface.

Shortened the default time between updates.

Fixed the middle click not opening video folder before configuration saved.

Fixed the quick info being changed to YoutubeDl after reload.

Changed the abort to allow the next url to start downloading if user did not pause the downloads.

Added the gtk file dialogs to be the default. (still working on the gtk version of the url list editor)

[Matthieu Baerts (matttbe)]

Hello,

I've to disapprove this change simply because it seems you've removed all other external applets :^^:

Can you move your 'YoutubeDl' directory somewhere else, delete your 'cairo-dock-plug-ins-extras' directory, re-download the branch (bzr branch lp:cairo-dock-plug-ins-extras) and commit your new features? :)

review: Needs Fixing

[Matthieu Baerts (matttbe)]

PS: you can push on the same branch with this command:
  $ bzr push lp:~mycompostpile/cairo-dock-plug-ins-extras/YoutubeDl --overwrite

[lp:~mycompostpile/cairo-dock-plug-ins-extras/YoutubeDl]

281. By Brian on 2012-06-14

YoutubeDl: Fixed the missing applet folders

282. By Brian on 2012-06-14

YoutubeDl: attempting to fix diverge error

[Brian (mycompostpile)]

Upload fixed. My apologies. I thought I was doing something wrong by uploading all the applets every time I made a change. Guess I am not used to bzr yet. Thanks for your patience.

[Matthieu Baerts (matttbe)]

Thank you for this new version!

I just have a problem with 'getClipboardText':

Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/dbus/connection.py", line 230, in maybe_handle_message
    self._handler(*args, **kwargs)
  File "/usr/lib/python2.7/dist-packages/CDApplet.py", line 168, in _on_build_menu
    self.on_build_menu()
  File "./YoutubeDl", line 329, in on_build_menu
    if getClipboardText():
  File "/opt/cairo-dock_bzr/cairo-dock-plug-ins-extras/YoutubeDl/getClipboardText.py", line 13, in getClipboardText
    if text.find("youtube.com/watch") == -1:

(or with the line 16 instead of 13)
I guess text is null at this moment but I think it's not a good idea to only show this entry menu when we have a correct weblink for two reasons:
 * this feature is hidden most of the time
 * it takes time before building the menu and the size of the menu can be wrong.
Note that it can be interesting to support short youtube links (youtu.be/VIDEO_ID) and maybe to support more than one link ;)

review: Needs Fixing

[lp:~mycompostpile/cairo-dock-plug-ins-extras/YoutubeDl]

283. By Brian on 2012-06-16

YoutubeDl: simplified getClipboardText; Fixed a couple of bugs in debuging code.

[Matthieu Baerts (matttbe)]

review: Approve

=== modified file 'YoutubeDl/YoutubeDl'
--- YoutubeDl/YoutubeDl	2012-06-11 02:43:29 +0000
+++ YoutubeDl/YoutubeDl	2012-06-16 03:04:23 +0000
@@ -35,6 +35,9 @@
 from constantTypes import PopupTypes
 from constantTypes import menuEntries
 
+#Get the clipboard text
+from getClipboardText import getClipboardText
+
 class Applet(CDApplet):
 
 	def __init__(self):
@@ -71,8 +74,8 @@
 	        self.icon.SetQuickInfo(str(self.result[0]))
             else:
 	        self.icon.SetQuickInfo('')
-            if self.__showStatusOnIcon:
-                self.icon.SetLabel("YoutubeDl")
+            # Uncomment the following line to trace debug actions in the console.
+            #self.debug()
             self.reload()
 	    self.__setTimer()
 
@@ -126,13 +129,18 @@
                      "editable" : False, })
                 self.currentDialog = PopupTypes.infoDialog
             else:
+                self.urlManualEntry()
+
+
+        def urlManualEntry(self):
+                defaultText = getClipboardText()
                 dialog_attributes = {
                         'message'    : "Please enter URL:",
                         'use-markup' : True,
                         'buttons'    : 'ok;cancel' }
                 widget_attributes = {
                         'widget-type'   : 'text-entry',
-                        'initial-value' : "",
+                        'initial-value' : defaultText,
                         'multi-lines'   : False}
                 self.icon.PopupDialog (dialog_attributes, widget_attributes)
                 self.currentDialog = PopupTypes.urlManualEntry
@@ -153,10 +161,18 @@
 
 	def on_middle_click(self):
             if self.__actionOnMiddleClick == 'Open Video Folder':
-                subprocess.call(['xdg-open',self.__videos_directory], shell=False)
+                if self.validVideoDirectory:
+                    subprocess.call(['xdg-open',self.__videos_directory], shell=False)
+                else:
+                    tempString = "Error: Video Directory not writable.\n Please make sure directory is valid and writable"
+                    self.icon.PopupDialog( {"message" : tempString,
+                    "icon" : "gtk-stock-edit"},
+                    {"visible" : True,
+                     "multi-lines" : True,
+                     "editable" : False, })
+                    self.currentDialog = PopupTypes.infoDialog
             else:
                 alerts.doUserAlert(self,self.resultSummary,4)
-                    
             return True
 	
 	def reload(self):
@@ -276,11 +292,23 @@
         def on_build_menu(self):
             self.messageDebug("onBuildMenu: context menu called")
             items = []
+            if self.validVideoDirectory:
+                if self.__actionOnMiddleClick == 'Open Video Folder':
+                    items.append(
+                    {"label": _("Open Video Folder") + " (" + _("middle-click") + ")",
+                     "icon" : "gtk-open",
+                     "id"   : menuEntries.openVideoFolder })
+                else:
+                    items.append(
+                    {"label": _("Show Download Status") + " (" + _("middle-click") + ")",
+                     "icon" : "gtk-info",
+                     "id"   : menuEntries.showDownloadStatus })
             if self.activeDownload:
                 items.append(
                 {"label": "Abort current download",
                  "icon" : "gtk-cancel",
-                 "id"   : menuEntries.abortDownload })
+                 "id"   : menuEntries.abortDownload,
+                 "tooltip" : _("Send abort signal to the downloader. There may be a delay") })
             if len(self.urlList) > 0:
                 items.append(
                 {"label": "Save current URL list", 
@@ -300,6 +328,11 @@
                 {"label": "Load URL list from file", 
                  "icon" : "gtk-open", 
                  "id"   : menuEntries.loadURLs })
+            if getClipboardText():
+                items.append(
+                {"label": "Add URL from clipboard", 
+                 "icon" : "gtk-edit", 
+                 "id"   : menuEntries.clipboardURL })
             if self.__startDownloads:
                 items.append(
                 {"label": "Pause Downloading", 
@@ -333,6 +366,12 @@
                 self.saveURLs()
             elif iNumEntry == menuEntries.loadURLs:
                 self.loadURLs()
+            elif iNumEntry == menuEntries.clipboardURL:
+                self.urlManualEntry()
+            elif iNumEntry == menuEntries.openVideoFolder:
+                subprocess.call(['xdg-open',self.__videos_directory], shell=False)
+            elif iNumEntry == menuEntries.showDownloadStatus:
+                alerts.doUserAlert(self,self.resultSummary,4)
             elif iNumEntry == menuEntries.pauseDownload:
                 self.__startDownloads = False
                 message = "Downloading Paused"
@@ -360,7 +399,6 @@
                     self.work_queue.put('Abort')
                     self.result = ['Aborting','Aborting','Aborting','Aborting']
 	            self.icon.SetQuickInfo(str(self.result[0]))
-                    self.__startDownloads = False
             elif self.currentDialog == PopupTypes.delList:
                 self.messageDebug("onAnswerDialog: confirm delete: "+str(button)+" "+str(userResponse))
                 if button == 0:
@@ -465,7 +503,7 @@
             Write debug message to console.
             """
             if self.__debugMode:
-                print '<%s : %s>' % (self.__name, message)
+                print '<%s : %s>' % (self.cAppletName, message)
 
         def debug(self):
             """
@@ -480,21 +518,21 @@
 	    """
 	    Reload the configuration.
 	    """
-	    interval = keyfile.getint('User Interface', 'interval')
+	    interval = keyfile.getint('Configuration', 'interval')
 	    self.__interval = interval * 1000 # convert in millisecondes.
-	    self.__startDownloads = keyfile.getboolean('User Interface', 'startDownloads')
-	    self.__showAlertStartDownloads = keyfile.getboolean('User Interface', 'showAlertStartDownloads')
-	    self.__showAlertDownloadComplete = keyfile.getboolean('User Interface', 'showAlertDownloadComplete')
-	    self.__showAlertDownloadAbort = keyfile.getboolean('User Interface', 'showAlertDownloadAbort')
-	    self.__showAlertAddURL = keyfile.getboolean('User Interface', 'showAlertAddURL')
-	    self.usePynotify = keyfile.getboolean('User Interface', 'usePynotify')
-	    self.useListView = keyfile.getboolean('User Interface', 'useListView')
-	    self.urlListExceeds = keyfile.getint('User Interface', 'urlListExceeds')
-	    self.__actionOnMiddleClick = keyfile.get('User Interface', 'actionOnMiddleClick')
-	    self.__showProgressOnIcon = keyfile.getboolean('User Interface', 'showProgressOnIcon')
-	    self.__showStatusOnIcon = keyfile.getboolean('User Interface', 'showStatusOnIcon')
-	    self.__videos_directory = keyfile.get('User Interface', 'videos_directory')
-	    self.__urlList_directory = keyfile.get('User Interface', 'urlList_directory')
+	    self.__startDownloads = keyfile.getboolean('Configuration', 'startDownloads')
+	    self.__showAlertStartDownloads = keyfile.getboolean('Configuration', 'showAlertStartDownloads')
+	    self.__showAlertDownloadComplete = keyfile.getboolean('Configuration', 'showAlertDownloadComplete')
+	    self.__showAlertDownloadAbort = keyfile.getboolean('Configuration', 'showAlertDownloadAbort')
+	    self.__showAlertAddURL = keyfile.getboolean('Configuration', 'showAlertAddURL')
+	    self.usePynotify = keyfile.getboolean('Configuration', 'usePynotify')
+	    self.useListView = keyfile.getboolean('Configuration', 'useListView')
+	    self.urlListExceeds = keyfile.getint('Configuration', 'urlListExceeds')
+	    self.__actionOnMiddleClick = keyfile.get('Configuration', 'actionOnMiddleClick')
+	    self.__showProgressOnIcon = keyfile.getboolean('Configuration', 'showProgressOnIcon')
+	    self.__showStatusOnIcon = keyfile.getboolean('Configuration', 'showStatusOnIcon')
+	    self.__videos_directory = keyfile.get('Configuration', 'videos_directory')
+	    self.__urlList_directory = keyfile.get('Configuration', 'urlList_directory')
 	    self.__setTimer()
 
             if not self.__videos_directory:

=== modified file 'YoutubeDl/YoutubeDl.conf'
--- YoutubeDl/YoutubeDl.conf	2012-06-11 02:43:29 +0000
+++ YoutubeDl/YoutubeDl.conf	2012-06-16 03:04:23 +0000
@@ -1,4 +1,4 @@
-#!en;0.0.9
+#!en;0.1.0
 
 #[gtk-about]
 [Icon]
@@ -91,8 +91,8 @@
 fg alpha = 1
 
 
-#User interface options
-[User Interface]
+#Configuration options
+[Configuration]
 
 #b Start downloading videos imediately? :
 #{Otherwise use right click and enable downloads}
@@ -101,15 +101,15 @@
 #v
 mySep =
 
-#i[1;300] Time between updates:
+#i[1;30] Time between updates:
 #{in secondds}
-interval = 30
+interval = 5
 
 #v
 mySep =
 
 #L[Open Video Folder;Show Status] Action on middle click:
-actionOnMiddleClick = 0
+actionOnMiddleClick = Open Video Folder
 
 #v
 mySep =

=== modified file 'YoutubeDl/auto-load.conf'
--- YoutubeDl/auto-load.conf	2012-06-11 02:43:29 +0000
+++ YoutubeDl/auto-load.conf	2012-06-16 03:04:23 +0000
@@ -4,13 +4,13 @@
 author = Brian
 
 # A short description of the applet and how to use it.
-description = This applet allows a user to drag Youtube links from the Youtube website and drop them on the icon to download. The backend downloader is based on youtube-dl.py.\n\n If you have python-tk installed on your system saving and loading url lists will be done using a graphical dialog box, otherwise you need to set the directory path in the configuration and just enter the filename in the popup box.\n\n If you have pynotify installed on your system you have the option of letting the notification area of your desktop handle the alerts, otherwise alerts will be done using the cairo-dock popup messages. You can turn this feature on or off under the configuration.\n\nCurrently the url list is not editable from the dock but if you save the list to a file you can edit with a text editor then load the list back into the plugin. Downloading can be paused from the context menu of the icon and you can choose to have downloads start automatically in the configuration area.\n\nThe left click button on the mouse brings up the current url list and the middle button can be configured for different actions.\n\nPlease enjoy.
+description = This applet allows a user to drag Youtube links from the Youtube website and drop them on the icon to download. The backend downloader is based on youtube-dl.py.\n\nOnly one video will be downloaded at a time and each url will be added to a list. When the video is downloaded or aborted the url will be removed from the list. The list can be saved to a file and loaded again for future use.\n\nThe middle mouse button can be configured to open the video folder or to show download status.\n\nRight clicking allows various options depending on what is happening at that time. If your video foler is not valid or not writeable then you can't download until it is corrected.\n\nIf there are no videos in the list left clicking on the icon allows you to enter a url. Otherwise the url list will be displayed.
 
 # Category of the applet : 2 = files, 3 = internet, 4 = Desktop, 5 = accessory, 6 = fun
 category = 3
 
 # Version of the applet; change it everytime you change something in the config file. Don't forget to update the version both in this file and in the config file.
-version = 0.0.9
+version = 0.1.0
 
 # Default icon to use if no icon has been defined by the user. If not specified, or if the file is not found, the "icon" file will be used.
 icon = 

=== modified file 'YoutubeDl/constantTypes.py'
--- YoutubeDl/constantTypes.py	2012-06-11 02:43:29 +0000
+++ YoutubeDl/constantTypes.py	2012-06-16 03:04:23 +0000
@@ -2,7 +2,7 @@
     (infoDialog, confirmAbort, saveListFilename, getListFilename, delList, showUrlList, urlManualEntry) = range(7)
 
 class menuEntries:
-    (abortDownload, saveURLs, loadURLs, pauseDownload, enableDownload, clearURLs, editURLs) = range(7)
+    (abortDownload, saveURLs, loadURLs, pauseDownload, enableDownload, clearURLs, editURLs, clipboardURL, openVideoFolder, showDownloadStatus) = range(10)
 
 class youtube:
     videoFormats = {"H264 - MP4 at 480p":'18',

=== modified file 'YoutubeDl/fileDialogs.py'
--- YoutubeDl/fileDialogs.py	2012-06-09 04:13:00 +0000
+++ YoutubeDl/fileDialogs.py	2012-06-16 03:04:23 +0000
@@ -1,34 +1,110 @@
 try:
-    import Tkinter, tkFileDialog
-    def openUrlFilename(initialDirectory):
-
-        rootDialog = Tkinter.Tk()
-
-        # define options for opening or saving a file
-        file_opt = options = {}
-        options['defaultextension'] = 'txt' # couldn't figure out how this works
-        options['filetypes'] = [('text files', '.txt'), ('all files', '.*')]
-        options['initialdir'] = initialDirectory
-        options['title'] = 'Please select a url list file to open'
-        options['parent'] = rootDialog
-        fileName = tkFileDialog.askopenfilename(**file_opt)
-        rootDialog.destroy()
-        return fileName
-
-    def saveUrlFilename(initialDirectory):
-        rootDialog = Tkinter.Tk()
-        file_opt = options = {}
-        options['defaultextension'] = 'txt' # couldn't figure out how this works
-        options['filetypes'] = [('text files', '.txt'), ('all files', '.*')]
-        options['initialdir'] = initialDirectory
-        options['title'] = 'Please select a url list file to save'
-        options['parent'] = rootDialog
-        fileName = tkFileDialog.asksaveasfilename(**file_opt)
-        rootDialog.destroy()
-        return fileName
-
-except ImportError:
-    def openUrlFilename(initialDirectory):
-        return None
-    def saveUrlFilename(initialDirectory):
-        return None
+    import pygtk
+    pygtk.require('2.0')
+
+    import gtk
+    def openUrlFilename(initialDirectory):
+        # Check for new pygtk: this is new class in PyGtk 2.4
+        if gtk.pygtk_version < (2,3,90):
+           print "PyGtk 2.3.90 or later required for this example"
+           raise SystemExit
+
+        dialog = gtk.FileChooserDialog("Open..",
+                                       None,
+                                       gtk.FILE_CHOOSER_ACTION_OPEN,
+                                       (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
+                                        gtk.STOCK_OPEN, gtk.RESPONSE_OK))
+        dialog.set_default_response(gtk.RESPONSE_OK)
+
+        filter = gtk.FileFilter()
+        filter.set_name("Text Files")
+        filter.add_pattern("*.txt")
+        dialog.add_filter(filter)
+
+        filter = gtk.FileFilter()
+        filter.set_name("All files")
+        filter.add_pattern("*")
+        dialog.add_filter(filter)
+
+        dialog.set_current_folder(initialDirectory)
+        response = dialog.run()
+        if response == gtk.RESPONSE_OK:
+            print "OK pressed: " + dialog.get_filename(), 'selected'
+            fileName = dialog.get_filename()
+        elif response == gtk.RESPONSE_CANCEL:
+            print "Cancel pressed: " + dialog.get_filename(), 'selected'
+            #print 'Closed, no files selected'
+            fileName = ''
+        dialog.destroy()
+        return fileName
+    def saveUrlFilename(initialDirectory):
+        # Check for new pygtk: this is new class in PyGtk 2.4
+        if gtk.pygtk_version < (2,3,90):
+           print "PyGtk 2.3.90 or later required for this example"
+           raise SystemExit
+
+        dialog = gtk.FileChooserDialog("Save..",
+                                       None,
+                                       gtk.FILE_CHOOSER_ACTION_SAVE,
+                                       (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
+                                        gtk.STOCK_OPEN, gtk.RESPONSE_OK))
+        dialog.set_default_response(gtk.RESPONSE_OK)
+
+        filter = gtk.FileFilter()
+        filter.set_name("Text Files")
+        filter.add_pattern("*.txt")
+        dialog.add_filter(filter)
+
+        filter = gtk.FileFilter()
+        filter.set_name("All files")
+        filter.add_pattern("*")
+        dialog.add_filter(filter)
+
+        dialog.set_current_folder(initialDirectory)
+        response = dialog.run()
+        if response == gtk.RESPONSE_OK:
+            print "OK pressed: " + str(dialog.get_filename()), 'selected'
+            fileName = dialog.get_filename()
+        elif response == gtk.RESPONSE_CANCEL:
+            print "Cancel pressed: " + str(dialog.get_filename()), 'selected'
+            #print 'Closed, no files selected'
+            fileName = ''
+        dialog.destroy()
+        return fileName
+#except ImportError:
+except:
+    try:
+        import Tkinter, tkFileDialog
+        def openUrlFilename(initialDirectory):
+
+            rootDialog = Tkinter.Tk()
+
+            # define options for opening or saving a file
+            file_opt = options = {}
+            options['defaultextension'] = 'txt' # couldn't figure out how this works
+            options['filetypes'] = [('text files', '.txt'), ('all files', '.*')]
+            options['initialdir'] = initialDirectory
+            options['title'] = 'Please select a url list file to open'
+            options['parent'] = rootDialog
+            fileName = tkFileDialog.askopenfilename(**file_opt)
+            rootDialog.destroy()
+            return fileName
+
+        def saveUrlFilename(initialDirectory):
+            rootDialog = Tkinter.Tk()
+            file_opt = options = {}
+            options['defaultextension'] = 'txt' # couldn't figure out how this works
+            options['filetypes'] = [('text files', '.txt'), ('all files', '.*')]
+            options['initialdir'] = initialDirectory
+            options['title'] = 'Please select a url list file to save'
+            options['parent'] = rootDialog
+            fileName = tkFileDialog.asksaveasfilename(**file_opt)
+            rootDialog.destroy()
+            return fileName
+
+    #except ImportError:
+    except:
+        def openUrlFilename(initialDirectory):
+            return None
+        def saveUrlFilename(initialDirectory):
+            return None

=== added file 'YoutubeDl/getClipboardText.py'
--- YoutubeDl/getClipboardText.py	1970-01-01 00:00:00 +0000
+++ YoutubeDl/getClipboardText.py	2012-06-16 03:04:23 +0000
@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+
+#try the gtk method of getting the clipboard contents first
+try:
+    import gtk
+
+    def getClipboardText():
+        clipboard = gtk.clipboard_get()
+        return clipboard.wait_for_text()
+except:
+    #next try the tkinter method of getting the clipboard contents
+    try:
+        import Tkinter
+        def getClipboardText():
+            root = Tkinter.Tk()
+            root.withdraw() # Hide the main window (optional)
+            return root.clipboard_get()
+    except:
+        #finally try the xclip method of getting the clipboard contents
+        try:
+            import subprocess
+            def getClipboardText():
+                try:
+                    p = subprocess.Popen(["xclip","-out","-selection","clipboard"],stdout=subprocess.PIPE,stderr=subprocess.PIPE,shell=False)
+                    clipText, errors = p.communicate()
+                    return clipText
+                except:
+                    #If xclip fails return nothing
+                    return ""
+        except:
+            #If all fails then return nothing
+            def getClipboardText():
+                return ""

=== modified file 'YoutubeDl/myYoutubeDownloader.py'
--- YoutubeDl/myYoutubeDownloader.py	2012-06-01 22:55:12 +0000
+++ YoutubeDl/myYoutubeDownloader.py	2012-06-16 03:04:23 +0000
@@ -71,7 +71,7 @@
             try:
                 url = self.work_queue.get()
                 self.__config.refresh()
-                videos_directory = self.__config.get('User Interface', 'videos_directory')
+                videos_directory = self.__config.get('Configuration', 'videos_directory')
                 self.useFormat = self.__config.get('Download Options', 'useFormat')
                 self.videoFormat = self.__config.get('Download Options', 'videoFormat')
                 self.maxVideoFormat = self.__config.get('Download Options', 'maxVideoFormat')
@@ -97,7 +97,7 @@
             except Queue.Empty:
                 time.sleep(1)
 
-    def debug():
+    def debug(self):
         global doDebug
         doDebug = True