Merge lp:~eduardo-mucelli/cairo-dock-plug-ins-extras/Quote into lp:~cairo-dock-team/cairo-dock-plug-ins-extras/third-party

[Eduardo Mucelli Rezende Oliveira]

Added Viedemerde.fr, and more documentation on the code. I hope this new documentation can make it easier to ours_en_pluche to get together with me on this applet :)

[Matthieu Baerts (matttbe)]

Hello and thank you for this new feature :)

It seems ok except that this file is missing: ViedemerdeParser.py

review: Needs Fixing (file missing)

[Eduardo Mucelli Rezende Oliveira (eduardo-mucelli)]

Damn, sorry!

As soon as I arrive at home, Im going to post it again.

Sorry about that.

On Mon, May 14, 2012 at 4:54 PM, Matthieu Baerts <email address hidden> wrote:

> Review: Needs Fixing file missing
>
> Hello and thank you for this new feature :)
>
> It seems ok except that this file is missing: ViedemerdeParser.py
>
> --
>
> https://code.launchpad.net/~eduardo-mucelli/cairo-dock-plug-ins-extras/Quote/+merge/105581
> You are the owner of lp:~eduardo-mucelli/cairo-dock-plug-ins-extras/Quote.
>

--
Eduardo Mucelli R. Oliveira ~
Launchpad<https://launchpad.net/%7Eeduardo-mucelli>

[Matthieu Baerts (matttbe)]

No problem, take time ;)

[lp:~eduardo-mucelli/cairo-dock-plug-ins-extras/Quote]

264. By Eduardo Mucelli Rezende Oliveira on 2012-05-14

ViedemerdeParser.py

[Eduardo Mucelli Rezende Oliveira (eduardo-mucelli)]

Added.

=== modified file 'Quote/ChangeLog'
--- Quote/ChangeLog	2012-03-28 20:50:03 +0000
+++ Quote/ChangeLog	2012-05-14 16:35:25 +0000
@@ -1,3 +1,4 @@
+0.1:(May/13/2012): Added Viedemerde.fr, and more documentation on the code
 0.0.9:(March/28/2012): Removed Grouphug.us because it is not offering the random quote anymore. Fixing the return from Bash and Qdb.
 0.0.8:(March/17/2010): Added Grouphug.us.
 0.0.7:(January/27/2010): Fixing the message when there were no translation for only one word. Adding Vidademerda.com.br. Adding next quote button in the PopupDialog.

=== modified file 'Quote/Quote'
--- Quote/Quote	2012-03-28 20:50:03 +0000
+++ Quote/Quote	2012-05-14 16:35:25 +0000
@@ -26,6 +26,18 @@
 
 from CDApplet import CDApplet, _
 
+# To add a new parser you have to:
+# 1 - Create a file NameOfTheSiteParser.py, see BashParser.py, QdbParser.py, etc
+# 1.1 - For specific parts on the creation of the parser, refer to BashParser, some documentation is there
+# 2 - Import it "from MyWebSiteParser (module name) import MyWebSiteParser (class name)"
+# 3 - Add one identificator for the parser, for example, "quotationspage" = 1. Look that we already have
+#     seven parsers = range(8). For each new one you add, you have  increment the parameter on the range method
+# 4 - On the fetch method, add a new block
+#     elif (self.source == mywebsite):
+#       parser = MyNewWebSiteParser
+#     And check if it is necessary to remove some extra character, check the documented part on the fetch method
+# 5 - Add the website option on the Quote.conf, see the [Configuration] section inside it
+
 from BashParser import BashParser                                       # Bash.org
 from QdbParser import QdbParser                                         # Qdb.us
 from XkcdbParser import XkcdbParser                                     # Xkcdb.com
@@ -33,8 +45,10 @@
 from DanstonchatParser import DanstonchatParser                         # Danstonchat.fr
 from JokestogoParser import JokestogoParser                             # Jokes2go.com
 from VidademerdaParser import VidademerdaParser                         # Vidademerda.com.br
+from ViedemerdeParser import ViedemerdeParser                           # Viedemerde.fr
 
-quotationspage, bash, xkcdb, qdb, danstonchat, jokestogo, vidademerda = range(7)  # quotationspage = 0, bash = 1, xkcdb = 2, qdb = 3, danstonchat = 4, jokestogo = 5, vidademerda = 6
+# quotationspage = 0, bash = 1, xkcdb = 2, qdb = 3, danstonchat = 4, jokestogo = 5, vidademerda = 6, viedemerde = 7
+quotationspage, bash, xkcdb, qdb, danstonchat, jokestogo, vidademerda, viedemerde = range(8)  
 
 class AgentOpener(FancyURLopener):
   """Masked user-agent otherwise the access would be forbidden"""
@@ -43,9 +57,9 @@
 class Interface:
 
   def __init__(self, source):
-    self.source = source
-    self.author = []
-    self.quote = []
+    self.source = source                                                # The source of the quotes, it is the 
+    self.author = []                                                    # List of authors of the current source
+    self.quote = []                                                     # List of quotes of the current source
 
   def fetch(self):
     if (self.source == quotationspage):
@@ -60,8 +74,10 @@
       parser = DanstonchatParser()                                      # DanstonchatParser.py
     elif (self.source == jokestogo):
       parser = JokestogoParser()
-    else:                                                               # VidademerdaParser.py
+    elif (self.source == vidademerda):                                  # VidademerdaParser.py
       parser = VidademerdaParser()
+    else:                                                               # ViedemerdeParser.py
+      parser = ViedemerdeParser()
 
     opener = AgentOpener()                                              # opens the web connection with masked user-agent
 
@@ -70,21 +86,24 @@
     except IOError:
       log ("Problem to open %s" % (parser.url))
     else:
-      parser.parse(page.read())                                         # feed the parser to get the specific content: translated text
-      page.close()                                                      # lets close the page connection
+      parser.parse(page.read())                                         # feed the parser with the page's content
+      page.close()                                                      # close the page connection
+      
+      # Handle different kind of returns from the parser. It is necessary because some sources return quotes with extra
+      # characters that we need to filter here. Some come with extra '', others come with linebreaks, etc.
       if (self.source == quotationspage):  
         self.quote = parser.quote
         self.author = parser.author
-      elif (self.source == bash or self.source == xkcdb or self.source == qdb or self.source == danstonchat):
+      elif (self.source == bash or self.source == xkcdb or self.source == qdb or self.source == danstonchat or self.source == viedemerde):
         self.quote = filter(None, parser.quote)                         # remove the '' from the array
       elif self.source == jokestogo:                                    # jokestogo
-        self.quote = filter(self.breakline, parser.quote)
+        self.quote = filter(self.linebreak, parser.quote)               # remove linebreak from the array
       else:                                                             # vidademerda
         self.quote = [''.join(parser.quote)]
         self.author = parser.author
     return self.quote, self.author
 
-  def breakline(self, item):
+  def linebreak(self, item):
     return not item == '\n'
 
 class Applet(CDApplet):
@@ -97,7 +116,7 @@
     self.copy_current_quote_key = 0
     self.go_next_quote_key = 1
     self.source = quotationspage
-    self.cSiteNames = ['Quotationspage.com','Bash.org','Xkcdb.com','Qdb.us','Danstonchat.com','Jokes2go.com','Vidademerda.com.br']
+    self.cSiteNames = ['Quotationspage.com','Bash.org','Xkcdb.com','Qdb.us','Danstonchat.com','Jokes2go.com','Vidademerda.com.br', 'Viedemerde.fr']
     
     CDApplet.__init__(self)                                             # call high-level init
   
@@ -108,26 +127,26 @@
 
   # Quotes
   def get_quotes_from_web(self):
-    self.inform_start_of_waiting_process()                              # ...
+    self.inform_start_of_waiting_process()                              # write "..." on the icon
     interface = Interface(self.source)
     quote, author = interface.fetch()
-    if (self.source == quotationspage):                                 # quotationspage nao da quotes diferentes por acesso ...
+    if (self.source == quotationspage):                                 # sources that gives the same quotes per fetch, we need circular iterator
       self.quotes = itertools.cycle(quote)
       self.authors = itertools.cycle(author)
-    else:                                                               # ... os outros dao quotes diferentes por acesso entao
-      self.quotes = iter(quote)                                         # nao precisa usar iterador circular, pois depois de mostrar
-      self.authors = iter(author)                                       # todas, busca-se novas quotes com mais uma chamada deste metodo
-    self.inform_end_of_waiting_process()                                # done
+    else:                                                               # all the rest of sources that gives different quotes per fetch, for example, 
+      self.quotes = iter(quote)                                         # pages that have "random" section from where we always fetch new quotes
+      self.authors = iter(author)                                       # from where we do not need to use circular iterator
+    self.inform_end_of_waiting_process()                                # remove the "..." from the icon
 
   def show_quote(self):
     if (self.source == quotationspage):
-      self.quotation = "\"%s\" ~ %s" % (self.quotes.next(), self.authors.next()) # N-esima quote refere-se ao N-esimo autor."quote[x]~author[x]"
-    elif (self.source == bash or self.source == xkcdb or self.source == qdb or self.source == danstonchat):
-      try:                                                              # ve a possibilidade de mostrar quotes ja armazenadas
+      self.quotation = "\"%s\" ~ %s" % (self.quotes.next(), self.authors.next()) # quote[x] ~ author[x]
+    elif (self.source == bash or self.source == xkcdb or self.source == qdb or self.source == danstonchat or self.source == viedemerde):
+      try:                                                              # check if it is possible to show the already stored quotes
         current = self.quotes.next()
-      except StopIteration:                                             # todas ja foram mostradas
-        self.get_quotes_from_web()                                      # buscar mais
-        current = self.quotes.next()                                    # posicionar na primeira para mostra-la
+      except StopIteration:                                             # all were already shown
+        self.get_quotes_from_web()                                      # fetch more
+        current = self.quotes.next()                                    # get the first
       self.quotation = "%s" % current
     elif (self.source == jokestogo):                                    # jokestogo provides only one quote per request ...
       self.quotation = "%s" % self.quotes.next().rstrip()                 
@@ -166,7 +185,7 @@
 
   def on_answer_dialog(self, key, content):
     if (key == self.copy_current_quote_key):                            # cancel button = 1, and copy_current_quote_key = 0
-      self.set_to_clipboard(self.quotation)                             # copia para a area de transferencia a quotation atual
+      self.set_to_clipboard(self.quotation)                             # copy to the transfer area the current quotation
     elif (key == self.go_next_quote_key or key == CDApplet.DIALOG_KEY_ENTER):
       self.show_quote()
 

=== modified file 'Quote/Quote.conf'
--- Quote/Quote.conf	2012-03-28 20:50:03 +0000
+++ Quote/Quote.conf	2012-05-14 16:35:25 +0000
@@ -1,4 +1,4 @@
-#0.0.9
+#0.1
 
 #[gtk-about]
 [Icon]
@@ -102,5 +102,5 @@
 
 #[gtk-preferences]
 [Configuration]
-#l[Quotationspage.com;Bash.org;Xkcdb.com;Qdb.us;Danstonchat.com;Jokes2go.com;Vidademerda.com.br] Quote source:
-source = 0
+#l[Quotationspage.com;Bash.org;Xkcdb.com;Qdb.us;Danstonchat.com;Jokes2go.com;Vidademerda.com.br;Viedemerde.fr] Quote source:
+source = 1

=== added file 'Quote/ViedemerdeParser.py'
--- Quote/ViedemerdeParser.py	1970-01-01 00:00:00 +0000
+++ Quote/ViedemerdeParser.py	2012-05-14 16:35:25 +0000
@@ -0,0 +1,42 @@
+# This is a part of the external Quote applet for Cairo-Dock
+#
+# Author: Eduardo Mucelli Rezende Oliveira
+# E-mail: [e-mail] or [e-mail]
+
+from sgmllib import SGMLParser
+
+class ViedemerdeParser(SGMLParser):
+
+  def reset(self):
+    SGMLParser.reset(self)
+    self.url = "http://www.viedemerde.fr/aleatoire"
+    self.quote = []                                         # list of quotes to be filled
+    self.inside_div_element = False                         # indicates if the parser is inside the <div></div> tag
+    self.inside_div_p_element = False
+    self.current_quote = ""
+
+  def start_div(self, attrs):
+    for name, value in attrs:
+      if name == "class" and value == "post article":       # <div class="post article">...</dt>
+        self.inside_div_element = True
+
+  def end_div(self):
+    self.inside_div_element = False
+
+  def start_p(self, attrs):
+    if self.inside_div_element:
+      self.inside_div_p_element = True                      # Parser is inside <div><p>...</p></div>
+
+  def end_p(self):
+    if self.inside_div_p_element:                           # if this is the end of our specific <div><p> tag,
+      self.quote.append(self.current_quote)                 # append the whole content found inside <div><p>...</p></div>,
+      self.current_quote = ""                               # clear it for the next quote,
+      self.inside_div_p_element = False                     # and mark as finished tag
+
+  def handle_data(self, text):
+    if self.inside_div_p_element:                           # Concatenate all the content inside <div><p>...</p></div>
+      self.current_quote += text
+
+  def parse(self, page):
+    self.feed(page)                                         # feed the parser with the page's html
+    self.close() 

=== modified file 'Quote/auto-load.conf'
--- Quote/auto-load.conf	2011-05-19 23:57:32 +0000
+++ Quote/auto-load.conf	2012-05-14 16:35:25 +0000
@@ -4,13 +4,13 @@
 author = Eduardo Mucelli Rezende Oliveira
 
 # A short description of the applet and how to use it.
-description = This applet provides a "Quote of the day" feature from some internet sources such as:\n Quotationspage.com, Bash.org, Xkcdb.com, Qdb.us, Danstonchat.com, Jokes2go.com, and Vidademerda.com.br
+description = This applet provides a "Quote of the day" feature from some internet sources such as:\n Quotationspage.com, Bash.org, Xkcdb.com, Qdb.us, Danstonchat.com, Jokes2go.com, Vidademerda.com.br, and Viedemerde.fr
 
 # Category of the applet : 2 = files, 3 = internet, 4 = Desktop, 5 = accessory, 6 = system, 7 = fun
 category = 7
 
 # 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
 
 # Whether the applet can be instanciated several times or not.
 multi-instance = true