Merge pull request #10 from pelican-plugins/dev

OAuth token authentication

Author: mpaglia0

README.md

@@ -42,10 +42,11 @@ In order to publish on Mastodon you need to enter in `.env` file, on the site ro
 
 ``` python
 MASTODON_BASE_URL="URL of your Mastodon instance. For example https://mastodon.social"
-MASTODON_USERNAME="Your username for Mastodon login"
-MASTODON_PASSWORD="You password for Mastodon login"
+MASTODON_OAUTH_TOKEN="Token of your Mastodon registered App"
 ```
 
+:exclamation: Starting from Mastodon 4.4.0 posting using Username/Password has been deprecated. Now you have to use the OAuth Token method instead. Your OAuth Token is available in the admin page of your web Mastodon page.
+
 There is no need to register an app in your Mastodon profile because *Fediverse* will do it for you!
 
 On every run *Fediverse* looks for a file called `pelicanfediverse_clientcred.secret` and - if it is not found - it gets in touch with Mastodon, creates an app called *PelicanFediverse* and writes API keys and other necessary information in this file.
@@ -59,9 +60,10 @@ In `pelicanconf.py` some new parameters can be defined
 
  - **MASTODON_VISIBILITY** : Set post's visiblity on mastodon. Can be 'direct', 'private', 'unlisted' or 'public'. Default value = 'direct' 
 
-  More details : https://mastodonpy.readthedocs.io/en/stable/05_statuses.html#writing 
+  More details : https://mastodonpy.readthedocs.io/en/stable/05_statuses.html#writing
+  
  - **MASTODON_READ_MORE** : Text to add at the end of the post, before link to the pelican's article. Default value = 'Read more: '
 
 ``` Python
 MASTODON_VISIBILITY='direct'
-MASTODON_READ_MORE='Read more: '
+MASTODON_READ_MORE='Read more: '

fediverse.py

@@ -37,34 +37,42 @@ def write_articleslist(articleslist):
 def post_on_mastodon(settings, new_posts):
 
    load_dotenv()
+   # Load admin details
    global mt_base_url
    mt_base_url = os.getenv('MASTODON_BASE_URL')
    global mt_username
-   mt_username = os.getenv('MASTODON_USERNAME')
+   mt_username = os.getenv('MASTODON_USERNAME') # DEPRECATED: to be removed soon
    global mt_password
-   mt_password = os.getenv('MASTODON_PASSWORD')
-
+   mt_password = os.getenv('MASTODON_PASSWORD') # DEPRECATED to be removed soon
+   global mt_token
+   mt_token = os.getenv('MASTODON_OAUTH_TOKEN')
+   # Load other details
    global mt_read_more
    mt_read_more = settings.get('MASTODON_READ_MORE', 'Read more: ')
    global mt_visibility
    mt_visibility = settings.get('MASTODON_VISIBILITY', 'direct')
 
-   # check if config file has been duly filled or print an error message and exit
-   if mt_base_url == '' or mt_username == '' or mt_password == '':
-      logger.warning('Pelican_fediverse: Mastodon access credentials not configured...')
+   # check if config file contains username and password and prompt the user this is deprecated
+   if mt_username or mt_password in globals():
+      logger.warning('Pelican_fediverse: password authentication is DEPRECATED and will be removed soon!\nPlease use OAuth token instead...')
+
+   # check if config file contains OAuth token and exit if not
+   if mt_base_url == '' or mt_token == '':
+      logger.warning('Pelican_fediverse: Mastodon instance URL and/or OAuth token are missing!\nPlease check your config file...')
       sys.exit(9)
 
-   # if pelicantoot_clientcred.secret does not exist it means we have to create the app on Mastodon
+   # if pelicantoot_clientcred.secret does not exist it means we have to create our Mastodon app
    if os.path.exists('pelicanfediverse_clientcred.secret') == False:
       Mastodon.create_app(
          'PelicanFediverse',
          api_base_url = mt_base_url,
          to_file = 'pelicanfediverse_clientcred.secret'
       )
 
-   # Advise the user with an on-screen message. We are ready to publish!
-   build_message = 'Publishing on Mastodon: %s (%s)'
+   # Prepare pubish a message for the user
+   build_message = 'Articles found to publish on Mastodon: %s (%s)'
 
+   # Collect/print information for articles
    for article in new_posts:
       url = article.get_siteurl() + article.url
       title = article.title
@@ -84,24 +92,17 @@ def post_updates(generator, writer):
       if article.url not in articleslist:
          new_posts.append(article)
 
-   # we only write the newly found sites to disk if posting them worked. that way we can retry later
+   # We only write the newly found sites to disk if posting them worked. That way we can retry later
    if new_posts:
       if post_on_mastodon(generator.settings, new_posts):
+         # Log in
          mastodon = Mastodon(
             client_id = 'pelicanfediverse_clientcred.secret',
+            access_token = mt_token,
             api_base_url = mt_base_url
          )
-         mastodon.log_in(
-            mt_username,
-            mt_password,
-            to_file = 'pelicanfediverse_usercred.secret'
-         )
-         mastodon = Mastodon(
-            access_token = 'pelicanfediverse_usercred.secret',
-            api_base_url = mt_base_url
-         )
-         # Actually build the post structure
-         # First set a maximum length for the final post
+         # Build the post structure
+         # First, set a maximum length for the final post
          toot_maxlength = 490 # Actually 500 but let's keep a safety gap for miscalculation...
          for article in new_posts:
             articleslist.append(article.url)