pastebin backend: Support login

Also add an option to Browser to avoid making useless requests.

weboob/backends/pastebin/backend.py

@@ -41,7 +41,9 @@ class PastebinBackend(BaseBackend, BasePasteBackend):
     LICENSE = 'AGPLv3+'
     BROWSER = PastebinBrowser
     CONFIG = ValuesDict(
-        Value('apikey', label='Optional API key', default='', masked=True),
+        Value('username', label='Optional username', default=''),
+        Value('password', label='Optional password', default='', masked=True),
+        Value('api_key',   label='Optional API key',  default='', masked=True),
     )
 
     EXPIRATIONS = {
@@ -52,6 +54,9 @@ class PastebinBackend(BaseBackend, BasePasteBackend):
         False: 'N',
     }
 
+    def create_default_browser(self):
+        return self.create_browser(self.config['api_key'], self.config['username'], self.config['password'], get_home=False)
+
     def new_paste(self, *args, **kwargs):
         return PastebinPaste(*args, **kwargs)
 
@@ -78,14 +83,14 @@ class PastebinBackend(BaseBackend, BasePasteBackend):
                 self.browser.fill_paste(paste)
         return paste
 
-    def post_paste(self, paste, max_age=None):
+    def post_paste(self, paste, max_age=None, use_api=True):
         if max_age is not None:
             expiration = self.get_closest_expiration(max_age)
         else:
             expiration = None
         with self.browser:
-            if self.config['apikey']:
+            if use_api and self.config.get('api_key'):
-                self.browser.api_post_paste(self.config['apikey'], paste, expiration=self.EXPIRATIONS.get(expiration))
+                self.browser.api_post_paste(paste, expiration=self.EXPIRATIONS.get(expiration))
             else:
                 self.browser.post_paste(paste, expiration=self.EXPIRATIONS.get(expiration))
 

weboob/backends/pastebin/browser.py

@@ -18,7 +18,7 @@
 # along with weboob. If not, see <http://www.gnu.org/licenses/>.
 
 
-from weboob.tools.browser import BaseBrowser, BrowserHTTPNotFound
+from weboob.tools.browser import BaseBrowser, BrowserHTTPNotFound, BrowserIncorrectPassword
 from weboob.tools.browser.decorators import id2url, check_url
 
 from weboob.capabilities.paste import PasteNotFound
@@ -43,12 +43,18 @@ class PastebinBrowser(BaseBrowser):
     PAGES = {PASTE_URL: PastePage,
             'http://%s/' % DOMAIN: PostPage}
 
+    def __init__(self, api_key, *args, **kwargs):
+        self.api_key = api_key
+        self.user_key = None
+
+        BaseBrowser.__init__(self, *args, **kwargs)
+
     def fill_paste(self, paste):
         """
         Get as much as information possible from the paste page
         """
         try:
-            self.location(paste.page_url)
+            self.location(paste.page_url, no_login=True)
             return self.page.fill_paste(paste)
         except BrowserHTTPNotFound:
             raise PasteNotFound()
@@ -72,16 +78,22 @@ class PastebinBrowser(BaseBrowser):
 
     def post_paste(self, paste, expiration=None):
         self.home()
+        if not self.is_on_page(PostPage):
+            self.home()
         self.page.post(paste, expiration=expiration)
         paste.id = self.page.get_id()
 
-    def api_post_paste(self, dev_key, paste, expiration=None):
+    def api_post_paste(self, paste, expiration=None):
-        data = {'api_dev_key': dev_key,
+        data = {'api_dev_key': self.api_key,
                 'api_option': 'paste',
-                'api_paste_expire_date': '1M',
-                'api_paste_private': '0' if paste.public else '1',
                 'api_paste_code': paste.contents.encode(self.ENCODING),
         }
+        if self.password:
+            data['api_user_key'] = self.api_login()
+        if paste.public is True:
+            data['api_paste_private'] = '0'
+        elif paste.public is False:
+            data['api_paste_private'] = '1'
         if paste.title:
             data['api_paste_name'] = paste.title.encode(self.ENCODING)
         if expiration:
@@ -90,7 +102,38 @@ class PastebinBrowser(BaseBrowser):
         self._validate_api_response(res)
         paste.id = re.match('^%s$' % self.PASTE_URL, res).groupdict()['id']
 
+    def api_login(self):
+        # "The api_user_key does not expire."
+        # TODO store it on disk
+        if self.user_key:
+            return self.user_key
+
+        data = {'api_dev_key': self.api_key,
+                'api_user_name': self.username,
+                'api_user_password': self.password
+        }
+        res = self.readurl('http://%s/api/api_login.php' % self.DOMAIN,
+                urllib.urlencode(data)).decode(self.ENCODING)
+        try:
+            self._validate_api_response(res)
+        except BadAPIRequest, e:
+            if str(e) == 'invalid login':
+                raise BrowserIncorrectPassword
+            else:
+                raise e
+        self.user_key = res
+        return res
+
     def _validate_api_response(self, res):
         matches = re.match('Bad API request, (?P<error>.+)', res)
         if matches:
             raise BadAPIRequest(matches.groupdict().get('error'))
+
+    def is_logged(self):
+        return self.page and self.page.is_logged()
+
+    def login(self):
+        self.location('http://%s/login' % self.DOMAIN, no_login=True)
+        self.page.login(self.username, self.password)
+        if not self.is_logged():
+            raise BrowserIncorrectPassword()

weboob/backends/pastebin/pages.py

@@ -22,7 +22,27 @@ from weboob.tools.browser import BasePage, BrokenPageError
 
 __all__ = ['PastePage', 'PostPage']
 
-class PastePage(BasePage):
+class BasePastebinPage(BasePage):
+    def is_logged(self):
+        header = self.parser.select(self.document.getroot(),
+                'id("header_bottom")/ul[@class="top_menu"]', 1, 'xpath')
+        for link in header.xpath('//ul/li/a'):
+            if link.text == 'logout':
+                return True
+            if link.text == 'login':
+                return False
+
+# XXX hack, since all pages are detected as a PostPage we make PastePage
+# inherit LoginPage
+class LoginPage(BasePastebinPage):
+    def login(self, username, password):
+        self.browser.select_form(nr=1)
+        self.browser['user_name'] = username.encode(self.browser.ENCODING)
+        self.browser['user_password'] = password.encode(self.browser.ENCODING)
+        self.browser.submit()
+
+
+class PastePage(LoginPage):
     def fill_paste(self, paste):
         header = self.parser.select(self.document.getroot(),
                 'id("content_left")//div[@class="paste_box_info"]', 1, 'xpath')
@@ -47,12 +67,15 @@ class PastePage(BasePage):
         return self.group_dict['id']
 
 
-class PostPage(BasePage):
+class PostPage(BasePastebinPage):
     def post(self, paste, expiration=None):
         self.browser.select_form(name='myform')
         self.browser['paste_code'] = paste.contents.encode(self.browser.ENCODING)
         self.browser['paste_name'] = paste.title.encode(self.browser.ENCODING)
-        self.browser['paste_private'] = ['0' if paste.public else '1']
+        if paste.public is True:
+            self.browser['paste_private'] = ['0']
+        elif paste.public is False:
+            self.browser['paste_private'] = ['1']
         if expiration:
             self.browser['paste_expire_date'] = [expiration]
         self.browser.submit()

weboob/tools/browser/browser.py

@@ -175,7 +175,7 @@ class BaseBrowser(mechanize.Browser):
 
     def __init__(self, username=None, password=None, firefox_cookies=None,
                  parser=None, history=NoHistory(), proxy=None, logger=None,
-                 factory=None):
+                 factory=None, get_home=True):
         """
         Constructor of Browser.
 
@@ -188,6 +188,7 @@ class BaseBrowser(mechanize.Browser):
                                 which does not keep history.
         @param proxy [str]  proxy URL to use.
         @param factory [object] Mechanize factory. None to use Mechanize's default.
+        @param get_home [bool] Try to get the homepage.
         """
         mechanize.Browser.__init__(self, history=history, factory=factory)
         self.logger = getLogger('browser', logger)
@@ -224,7 +225,7 @@ class BaseBrowser(mechanize.Browser):
         self.username = username
         self.password = password
         self.lock = RLock()
-        if self.password:
+        if self.password and get_home:
             try:
                 self.home()
             # Do not abort the build of browser when the website is down.