v2.1.5-beta

Typo in Newsletter Parameters

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## v2.1.5-beta (2018-05-07)
+
+* Newsletters:
+  * New: Added setting for a custom newsletter template folder.
+  * New: Added option to enable static newsletter URLs to retrieve the last sent scheduled newsletter.
+  * New: Added ability to change the newsletter output directory and filenames.
+  * New: Added option to save the newsletter file without sending it to a notification agent.
+  * Fix: Check for disabled image hosting setting.
+  * Fix: Cache newsletter images when refreshing the page.
+  * Fix: Refresh image from the Plex server when uploading to image hosting.
+  * Change: Allow all image hosting options with self-hosted newsletters.
+* UI:
+  * Change: Don't retrieve recently added on the homepage if the Plex Cloud server is sleeping.
+* Other:
+  * Fix: Imgur database upgrade migration.
+
+
 ## v2.1.4 (2018-05-05)
 
 * Newsletters:

data/interfaces/default/index.html

@@ -5,6 +5,7 @@
 </%def>
 
 <%def name="body()">
+<% from plexpy import PLEX_SERVER_UP %>
 <div class="container-fluid">
     % for section in config['home_sections']:
     % if section == 'current_activity':
@@ -22,7 +23,6 @@
                 </h3>
             </div>
             <div id="currentActivity">
-                <% from plexpy import PLEX_SERVER_UP %>
                 % if PLEX_SERVER_UP:
                 <div class="text-muted" id="dashboard-checking-activity"><i class="fa fa-refresh fa-spin"></i> Checking for activity...</div>
                 % elif config['pms_is_cloud']:
@@ -135,7 +135,17 @@
     <div class="row">
         <div class="col-md-12">
             <div id="recentlyAdded" style="margin-right: -15px;">
+                % if PLEX_SERVER_UP:
                 <div class="text-muted"><i class="fa fa-refresh fa-spin"></i> Looking for new items...</div>
+                % elif config['pms_is_cloud']:
+                <div class="text-muted">Plex Cloud server is sleeping.</div>
+                % else:
+                <div class="text-muted">There was an error communicating with your Plex Server.
+                    % if _session['user_group'] == 'admin':
+                    Check the <a href="logs">logs</a> and verify your server connection in the <a href="settings#tab_tabs-plex_media_server">settings</a>.
+                    % endif
+                </div>
+                % endif
                 <br>
             </div>
         </div>
@@ -222,6 +232,7 @@
 </%def>
 
 <%def name="javascriptIncludes()">
+<% from plexpy import PLEX_SERVER_UP %>
 <script src="${http_root}js/moment-with-locale.js"></script>
 <script src="${http_root}js/jquery.scrollbar.min.js"></script>
 <script src="${http_root}js/jquery.mousewheel.min.js"></script>
@@ -254,7 +265,6 @@
         });
     }
 </script>
-<% from plexpy import PLEX_SERVER_UP %>
 % if 'current_activity' in config['home_sections'] and PLEX_SERVER_UP:
 <script>
     var defaultHandler = {
@@ -746,7 +756,7 @@
     getLibraryStats();
 </script>
 % endif
-% if 'recently_added' in config['home_sections']:
+% if 'recently_added' in config['home_sections'] and PLEX_SERVER_UP:
 <script>
     function recentlyAdded(recently_added_count, recently_added_type) {
         showMsg("Loading recently added items...", true, false, 0);

data/interfaces/default/newsletter_config.html

@@ -166,6 +166,15 @@
                                     % endfor
                                 </div>
                                 <div class="col-md-12" style="margin-top: 10px; padding-top: 10px; border-top: 1px solid #444;">
+                                    <div class="form-group">
+                                        <label for="newsletter_config_filename">Filename</label>
+                                        <div class="row">
+                                            <div class="col-md-12">
+                                                <input type="text" class="form-control" id="newsletter_config_filename" name="newsletter_config_filename" value="${newsletter['config']['filename']}" size="30">
+                                            </div>
+                                        </div>
+                                        <p class="help-block">The filename to use when saving the newsletter (ending with <span class="inline-pre">.html</span>). You may use any of the <a href="#newsletter-text-sub-modal" data-toggle="modal">newsletter text parameters</a>. Leave blank for default.</p>
+                                    </div>
                                     <div class="form-group">
                                         <label for="friendly_name">Description</label>
                                         <div class="row">
@@ -183,7 +192,14 @@
                                 <div class="col-md-12">
                                     <div class="checkbox">
                                         <label>
-                                            <input type="checkbox" id="newsletter_config_formatted_checkbox" data-id="newsletter_config_formatted" class="checkboxes" value="1" ${checked(newsletter['config']['formatted'])}> Send newsletter as an HTML formatted Email
+                                            <input type="checkbox" id="newsletter_config_save_only_checkbox" data-id="newsletter_config_save_only" class="checkboxes" value="1" ${checked(newsletter['config']['save_only'])}> Save Newsletter File Only
+                                        </label>
+                                        <p class="help-block">Enable to save the newsletter file without sending it to any notification agent.</p>
+                                        <input type="hidden" id="newsletter_config_save_only" name="newsletter_config_save_only" value="${newsletter['config']['save_only']}">
+                                    </div>
+                                    <div class="checkbox">
+                                        <label>
+                                            <input type="checkbox" id="newsletter_config_formatted_checkbox" data-id="newsletter_config_formatted" class="checkboxes" value="1" ${checked(newsletter['config']['formatted'])}> Send Newsletter as an HTML Formatted Email
                                         </label>
                                         <p class="help-block">Enable to send the newsletter as an HTML formatted Email. Disable to only send a subject and body message to a different notification agent.</p>
                                         <input type="hidden" id="newsletter_config_formatted" name="newsletter_config_formatted" value="${newsletter['config']['formatted']}">
@@ -458,6 +474,15 @@
         toggleCustomCron();
     });
 
+    function validateFilename() {
+        var filename = $('#newsletter_config_filename').val();
+        if (filename !== '' && !(filename.endsWith('.html'))) {
+            showMsg('<i class="fa fa-times"></i> Failed to save newsletter. Invalid filename.', false, true, 5000, true);
+            return false;
+        } else {
+            return true;
+        }
+    }
     var $incl_libraries = $('#newsletter_config_incl_libraries').selectize({
         plugins: ['remove_button'],
         maxItems: null,
@@ -643,7 +668,9 @@
         if ($('#custom_cron').val() === '0'){
             $("#cron_value").val(cron_widget.cron('value'));
         }
-        doAjaxCall('set_newsletter_config', $(this), 'tabs', true, true, saveCallback);
+        if (validateFilename()){
+            doAjaxCall('set_newsletter_config', $(this), 'tabs', true, true, saveCallback);
+        }
     }
 
     $('#delete-newsletter-item').click(function () {

data/interfaces/default/newsletter_preview.html

@@ -32,7 +32,7 @@
 <script>
 $(document).ready(function () {
     var frame = $('<iframe></iframe>', {
-        src: '${http_root}real_newsletter?${urllib.urlencode(kwargs) | n}',
+        src: 'real_newsletter?${urllib.urlencode(kwargs) | n}',
         frameborder: '0',
         style: 'display: none; height: 100vh; width: 100vw;'
     });

data/interfaces/default/settings.html

@@ -702,6 +702,17 @@
                                 The server URL that Tautulli will use to connect to your Plex server. Retrieved automatically.
                             </p>
                         </div>
+                        <div class="form-group advanced-setting">
+                            <label for="pms_url">Plex Server Identifier</label>
+                            <div class="row">
+                                <div class="col-md-6">
+                                    <input type="text" class="form-control" id="pms_identifier" name="pms_identifier" value="${config['pms_identifier']}" size="30" readonly>
+                                </div>
+                            </div>
+                            <p class="help-block">
+                                The unique identifier for your Plex server. Retrieved automatically.
+                            </p>
+                        </div>
                         <div class="checkbox advanced-setting">
                             <label>
                                 <input type="checkbox" class="pms-settings" id="pms_url_manual" name="pms_url_manual" value="1" ${config['pms_url_manual']}> Manual Connection
@@ -728,7 +739,6 @@
                         </div>
 
                         <input type="hidden" id="pms_is_cloud" name="pms_is_cloud" value="${config['pms_is_cloud']}">
-                        <input type="hidden" id="pms_identifier" name="pms_identifier" value="${config['pms_identifier']}">
                         <input type="checkbox" name="server_changed" id="server_changed" value="1" style="display: none;">
 
                         <div class="form-group advanced-setting">
@@ -956,10 +966,35 @@
                         </div>
                         <div id="self_host_newsletter_options" style="overlfow: hidden; display: ${'block' if config['newsletter_self_hosted'] == 'checked' else 'none'}">
                             <p class="help-block" id="self_host_newsletter_message">
-                                Note: The <span class="inline-pre">${http_root}newsletter</span> endpoint on your domain must be publicly accessible from the internet.<br>
-                                Note: Newsletter images will be self-hosted regardless of the Image Hosting setting below.<br>
+                                Note: The <span class="inline-pre">${http_root}newsletter</span> endpoint on your domain must be publicly accessible from the internet.
                             </p>
                             <p class="help-block settings-warning base-url-warning">Warning: Public Tautulli domain not set under <a data-tab-destination="tabs-web_interface" data-target="#http_base_url">Web Interface</a>.</p>
+
+                            <div class="checkbox">
+                                <label>
+                                    <input type="checkbox" id="newsletter_static_url" name="newsletter_static_url" value="1" ${config['newsletter_static_url']}> Enable Static Newsletter URL
+                                </label>
+                                <p class="help-block">Enable static newsletter URLs to the last sent scheduled newsletter at <span class="inline-pre">${http_root}newsletter/id/&lt;newsletter_id&gt;</span>.</p>
+                            </div>
+                        </div>
+
+                        <div class="form-group advanced-setting">
+                            <label for="newsletter_dir">Custom Newsletter Templates Folder</label>
+                            <div class="row">
+                                <div class="col-md-6">
+                                    <input type="text" class="form-control" id="newsletter_custom_dir" name="newsletter_custom_dir" value="${config['newsletter_custom_dir']}">
+                                </div>
+                            </div>
+                            <p class="help-block">Optional: Enter the full path to your custom newsletter templates folder. Leave blank for default.</p>
+                        </div>
+                        <div class="form-group advanced-setting">
+                            <label for="newsletter_dir">Newsletter Output Directory</label>
+                            <div class="row">
+                                <div class="col-md-6">
+                                    <input type="text" class="form-control" id="newsletter_dir" name="newsletter_dir" value="${config['newsletter_dir']}">
+                                </div>
+                            </div>
+                            <p class="help-block">Enter the full path to where newsletter files will be saved.</p>
                         </div>
 
                         <div class="padded-header">
@@ -1084,7 +1119,7 @@
                             Add a new newsletter agent, or configure an existing newsletter agent by clicking the settings icon on the right.
                         </p>
                         <p class="help-block settings-warning" id="newsletter_upload_warning">
-                            Note: Either <a data-tab-destination="tabs-notifications" data-target="#notify_upload_posters">Image Hosting</a> or <a data-tab-destination="tabs-notifications" data-target="#newsletter_self_hosted">Self-Hosted Newsletters</a> must be enabled.</span>
+                            Warning: <a data-tab-destination="tabs-notifications" data-target="#notify_upload_posters">Image Hosting</a> must be enabled for images to display on the newsletter.</span>
                         </p>
                         <br/>
                         <div id="plexpy-newsletters-table">
@@ -1173,14 +1208,6 @@
                                 </div>
                             </div>
                         </div>
-                        <div class="form-group">
-                            <label for="newsletter_dir">Newsletter Directory</label>
-                            <div class="row">
-                                <div class="col-md-6">
-                                    <input type="text" class="form-control directory-settings" id="newsletter_dir" name="newsletter_dir" value="${config['newsletter_dir']}">
-                                </div>
-                            </div>
-                        </div>
 
                         <p><input type="button" class="btn btn-bright save-button" value="Save" data-success="Changes saved successfully"></p>
 
@@ -2605,10 +2632,10 @@ $(document).ready(function() {
     });
 
     function newsletterUploadEnabled() {
-        if ($('#notify_upload_posters').val() !== '2' || $('#newsletter_self_hosted').is(':checked')) {
-            $('#newsletter_upload_warning').hide();
-        } else {
+        if ($('#notify_upload_posters').val() === '0') {
             $('#newsletter_upload_warning').show();
+        } else {
+            $('#newsletter_upload_warning').hide();
         }
     }
     newsletterUploadEnabled();

data/interfaces/newsletters/recently_added.html

@@ -1,17 +1,24 @@
 % if data:
 <%
     import plexpy
-    from plexpy.helpers import grouper
+    from plexpy.helpers import grouper, get_img_service
 
     recently_added = data['recently_added']
     if plexpy.CONFIG.NEWSLETTER_SELF_HOSTED and plexpy.CONFIG.HTTP_BASE_URL:
         base_url = plexpy.CONFIG.HTTP_BASE_URL + plexpy.HTTP_ROOT + 'newsletter/'
-        base_url_image = base_url + 'image/'
     elif preview:
         base_url = 'newsletter/'
-        base_url_image = base_url + 'image/'
     else:
-        base_url = base_url_image = ''
+        base_url = ''
+
+    service = get_img_service()
+    if get_img_service(include_self=True) == 'self-hosted' and plexpy.CONFIG.HTTP_BASE_URL:
+        base_url_image = plexpy.CONFIG.HTTP_BASE_URL + plexpy.HTTP_ROOT + 'newsletter/image/'
+    elif service and preview:
+        base_url_image = 'newsletter/image/'
+    else:
+        base_url_image = ''
+
 %>
 <!doctype html>
 <html>
@@ -83,6 +90,14 @@
         /* -------------------------------------
             HEADER, FOOTER, MAIN
         ------------------------------------- */
+        .local-preview-note {
+            text-align: center;
+            padding-top: 10px;
+        }
+        .local-preview-note p {
+            color: #282A2D;
+            font-size: 12px;
+        }
         .main {
             background: #282A2D;
             border-radius: 3px;
@@ -608,6 +623,9 @@
     </style>
 </head>
 <body class="" style="font-family: 'Open Sans', Helvetica, Arial, sans-serif;-webkit-font-smoothing: antialiased;font-size: 14px;line-height: 1.4;margin: 0;padding: 0;-ms-text-size-adjust: 100%;-webkit-text-size-adjust: 100%;">
+% if preview and service:
+<div class="local-preview-note" style="text-align: center;padding-top: 10px;"><p style="font-family: 'Open Sans', Helvetica, Arial, sans-serif;font-weight: 400;margin: 0;color: #282A2D;font-size: 12px;">Note: Local preview only - images have not been uploaded to ${service.capitalize()}</p></div>  <!-- IGNORE SAVE -->
+% endif
 <table border="0" cellpadding="0" cellspacing="0" class="body" style="border-collapse: separate;mso-table-lspace: 0pt;mso-table-rspace: 0pt;width: 100%;">
     <tr>
         <td class="container" style="font-family: 'Open Sans', Helvetica, Arial, sans-serif;font-size: 14px;vertical-align: top;display: block;max-width: 1042px;padding: 10px;width: 1042px;margin: 0 auto !important;">

data/interfaces/newsletters/recently_added_master.html

@@ -1,17 +1,24 @@
 % if data:
 <%
     import plexpy
-    from plexpy.helpers import grouper
+    from plexpy.helpers import grouper, get_img_service
 
     recently_added = data['recently_added']
     if plexpy.CONFIG.NEWSLETTER_SELF_HOSTED and plexpy.CONFIG.HTTP_BASE_URL:
         base_url = plexpy.CONFIG.HTTP_BASE_URL + plexpy.HTTP_ROOT + 'newsletter/'
-        base_url_image = base_url + 'image/'
     elif preview:
         base_url = 'newsletter/'
-        base_url_image = base_url + 'image/'
     else:
-        base_url = base_url_image = ''
+        base_url = ''
+
+    service = get_img_service()
+    if get_img_service(include_self=True) == 'self-hosted' and plexpy.CONFIG.HTTP_BASE_URL:
+        base_url_image = plexpy.CONFIG.HTTP_BASE_URL + plexpy.HTTP_ROOT + 'newsletter/image/'
+    elif service and preview:
+        base_url_image = 'newsletter/image/'
+    else:
+        base_url_image = ''
+
 %>
 <!doctype html>
 <html>
@@ -83,6 +90,14 @@
         /* -------------------------------------
             HEADER, FOOTER, MAIN
         ------------------------------------- */
+        .local-preview-note {
+            text-align: center;
+            padding-top: 10px;
+        }
+        .local-preview-note p {
+            color: #282A2D;
+            font-size: 12px;
+        }
         .main {
             background: #282A2D;
             border-radius: 3px;
@@ -608,6 +623,9 @@
     </style>
 </head>
 <body class="">
+% if preview and service:
+<div class="local-preview-note"><p>Note: Local preview only - images have not been uploaded to ${service.capitalize()}</p></div>  <!-- IGNORE SAVE -->
+% endif
 <table border="0" cellpadding="0" cellspacing="0" class="body">
     <tr>
         <td class="container">

plexpy/__init__.py

@@ -648,7 +648,7 @@ def dbcheck():
         'CREATE TABLE IF NOT EXISTS newsletter_log (id INTEGER PRIMARY KEY AUTOINCREMENT, timestamp INTEGER, '
         'newsletter_id INTEGER, agent_id INTEGER, agent_name TEXT, notify_action TEXT, '
         'subject_text TEXT, body_text TEXT, message_text TEXT, start_date TEXT, end_date TEXT, '
-        'start_time INTEGER, end_time INTEGER, uuid TEXT UNIQUE, success INTEGER DEFAULT 0)'
+        'start_time INTEGER, end_time INTEGER, uuid TEXT UNIQUE, filename TEXT, success INTEGER DEFAULT 0)'
     )
 
     # recently_added table :: This table keeps record of recently added items
@@ -1495,6 +1495,15 @@ def dbcheck():
             'ALTER TABLE newsletter_log ADD COLUMN end_time INTEGER'
         )
 
+    # Upgrade newsletter_log table from earlier versions
+    try:
+        c_db.execute('SELECT filename FROM newsletter_log')
+    except sqlite3.OperationalError:
+        logger.debug(u"Altering database. Updating database table newsletter_log.")
+        c_db.execute(
+            'ALTER TABLE newsletter_log ADD COLUMN filename TEXT'
+        )
+
     # Upgrade library_sections table from earlier versions (remove UNIQUE constraint on section_id)
     try:
         result = c_db.execute('SELECT SQL FROM sqlite_master WHERE type="table" AND name="library_sections"').fetchone()
@@ -1694,9 +1703,9 @@ def dbcheck():
             for row in result:
                 img_hash = notification_handler.set_hash_image_info(
                     rating_key=row['rating_key'], width=1000, height=1500, fallback='poster')
-                data_factory.set_imgur_info(img_hash=img_hash, imgur_title=row['poster_title'],
-                                            imgur_url=row['poster_url'], delete_hash=row['delete_hash'],
-                                            service='imgur')
+                data_factory.set_img_info(img_hash=img_hash, imgur_title=row['poster_title'],
+                                          imgur_url=row['poster_url'], delete_hash=row['delete_hash'],
+                                          service='imgur')
 
             db.action('DROP TABLE poster_urls')
     except sqlite3.OperationalError:

plexpy/common.py

@@ -519,13 +519,15 @@ NEWSLETTER_PARAMETERS = [
         'category': 'Global',
         'parameters': [
             {'name': 'Server Name', 'type': 'str', 'value': 'server_name', 'description': 'The name of your Plex Server.'},
-            {'name': 'Start Date', 'type': 'str', 'value': 'start_date', 'description': 'The start date of the newesletter.'},
-            {'name': 'End Date', 'type': 'str', 'value': 'end_date', 'description': 'The end date of the newesletter.'},
+            {'name': 'Start Date', 'type': 'str', 'value': 'start_date', 'description': 'The start date of the newsletter.'},
+            {'name': 'End Date', 'type': 'str', 'value': 'end_date', 'description': 'The end date of the newsletter.'},
             {'name': 'Week Number', 'type': 'int', 'value': 'week_number', 'description': 'The week number of the year.'},
             {'name': 'Newsletter Time Frame', 'type': 'int', 'value': 'newsletter_time_frame', 'description': 'The time frame included in the newsletter.'},
             {'name': 'Newsletter Time Frame Units', 'type': 'str', 'value': 'newsletter_time_frame_units', 'description': 'The time frame units included in the newsletter.'},
             {'name': 'Newsletter URL', 'type': 'str', 'value': 'newsletter_url', 'description': 'The self-hosted URL to the newsletter.'},
+            {'name': 'Newsletter Static URL', 'type': 'str', 'value': 'newsletter_static_url', 'description': 'The static self-hosted URL to the latest scheduled newsletter for the agent.'},
             {'name': 'Newsletter UUID', 'type': 'str', 'value': 'newsletter_uuid', 'description': 'The unique identifier for the newsletter.'},
+            {'name': 'Newsletter ID', 'type': 'int', 'value': 'newsletter_id', 'description': 'The ID number for the newsletter agent.'},
         ]
      },
     {

plexpy/config.py

@@ -312,9 +312,11 @@ _CONFIG_DEFINITIONS = {
     'MONITOR_REMOTE_ACCESS': (int, 'Monitoring', 0),
     'MONITORING_INTERVAL': (int, 'Monitoring', 60),
     'MONITORING_USE_WEBSOCKET': (int, 'Monitoring', 0),
+    'NEWSLETTER_CUSTOM_DIR': (str, 'Newsletter', ''),
     'NEWSLETTER_TEMPLATES': (str, 'Newsletter', 'newsletters'),
     'NEWSLETTER_DIR': (str, 'Newsletter', ''),
     'NEWSLETTER_SELF_HOSTED': (int, 'Newsletter', 0),
+    'NEWSLETTER_STATIC_URL': (int, 'Newsletter', 0),
     'NMA_APIKEY': (str, 'NMA', ''),
     'NMA_ENABLED': (int, 'NMA', 0),
     'NMA_PRIORITY': (int, 'NMA', 0),

plexpy/helpers.py

@@ -834,7 +834,8 @@ def cloudinary_transform(rating_key=None, width=1000, height=1500, opacity=100,
         api_secret=plexpy.CONFIG.CLOUDINARY_API_SECRET
     )
 
-    img_options = {}
+    img_options = {'format': img_format,
+                   'version': int(time.time())}
 
     if width != 1000:
         img_options['width'] = str(width)
@@ -849,14 +850,11 @@ def cloudinary_transform(rating_key=None, width=1000, height=1500, opacity=100,
     if blur != 0:
         img_options['effect'] = 'blur:{}'.format(blur * 100)
 
-    if img_options:
-        img_options['format'] = img_format
-
-        try:
-            url, options = cloudinary_url('{}_{}'.format(fallback, rating_key), **img_options)
-            logger.debug(u"Tautulli Helpers :: Image '{}' ({}) transformed on Cloudinary.".format(img_title, fallback))
-        except Exception as e:
-            logger.error(u"Tautulli Helpers :: Unable to transform image '{}' ({}) on Cloudinary: {}".format(img_title, fallback, e))
+    try:
+        url, options = cloudinary_url('{}_{}'.format(fallback, rating_key), **img_options)
+        logger.debug(u"Tautulli Helpers :: Image '{}' ({}) transformed on Cloudinary.".format(img_title, fallback))
+    except Exception as e:
+        logger.error(u"Tautulli Helpers :: Unable to transform image '{}' ({}) on Cloudinary: {}".format(img_title, fallback, e))
 
     return url
 

plexpy/newsletter_handler.py

@@ -86,7 +86,8 @@ def notify(newsletter_id=None, notify_action=None, **kwargs):
         body = newsletter_config['body']
         message = newsletter_config['message']
 
-    newsletter_agent = newsletters.get_agent_class(agent_id=newsletter_config['agent_id'],
+    newsletter_agent = newsletters.get_agent_class(newsletter_id=newsletter_id,
+                                                   agent_id=newsletter_config['agent_id'],
                                                    config=newsletter_config['config'],
                                                    email_config=newsletter_config['email_config'],
                                                    subject=subject,
@@ -100,6 +101,7 @@ def notify(newsletter_id=None, notify_action=None, **kwargs):
                                          subject=newsletter_agent.subject_formatted,
                                          body=newsletter_agent.body_formatted,
                                          message=newsletter_agent.message_formatted,
+                                         filename=newsletter_agent.filename_formatted,
                                          start_date=newsletter_agent.start_date.format('YYYY-MM-DD'),
                                          end_date=newsletter_agent.end_date.format('YYYY-MM-DD'),
                                          start_time=newsletter_agent.start_time,
@@ -114,7 +116,7 @@ def notify(newsletter_id=None, notify_action=None, **kwargs):
         return True
 
 
-def set_notify_state(newsletter, notify_action, subject, body, message,
+def set_notify_state(newsletter, notify_action, subject, body, message, filename,
                      start_date, end_date, start_time, end_time, newsletter_uuid):
 
     if newsletter and notify_action:
@@ -133,7 +135,8 @@ def set_notify_state(newsletter, notify_action, subject, body, message,
                   'start_date': start_date,
                   'end_date': end_date,
                   'start_time': start_time,
-                  'end_time': end_time}
+                  'end_time': end_time,
+                  'filename': filename}
 
         db.upsert(table_name='newsletter_log', key_dict=keys, value_dict=values)
         return db.last_insert_id()
@@ -149,20 +152,29 @@ def set_notify_success(newsletter_log_id):
     db.upsert(table_name='newsletter_log', key_dict=keys, value_dict=values)
 
 
-def get_newsletter(newsletter_uuid):
+def get_newsletter(newsletter_uuid=None, newsletter_id=None):
     db = database.MonitorDatabase()
-    result = db.select_single('SELECT newsletter_id, start_date, end_date FROM newsletter_log '
-                              'WHERE uuid = ?', [newsletter_uuid])
+
+    if newsletter_uuid:
+        result = db.select_single('SELECT newsletter_id, start_date, end_date, uuid, filename FROM newsletter_log '
+                                  'WHERE uuid = ?', [newsletter_uuid])
+    elif newsletter_id:
+        result = db.select_single('SELECT newsletter_id, start_date, end_date, uuid, filename FROM newsletter_log '
+                                  'WHERE newsletter_id = ? AND notify_action != "test" '
+                                  'ORDER BY timestamp DESC LIMIT 1', [newsletter_id])
+    else:
+        result = None
 
     if result:
         newsletter_id = result['newsletter_id']
+        newsletter_uuid = result['uuid']
         start_date = result['start_date']
         end_date = result['end_date']
+        newsletter_file = result['filename'] or 'newsletter_%s-%s_%s.html' % (start_date.replace('-', ''),
+                                                                              end_date.replace('-', ''),
+                                                                              newsletter_uuid)
 
-        newsletter_file = 'newsletter_%s-%s_%s.html' % (start_date.replace('-', ''),
-                                                        end_date.replace('-', ''),
-                                                        newsletter_uuid)
-        newsletter_folder = plexpy.CONFIG.NEWSLETTER_DIR
+        newsletter_folder = plexpy.CONFIG.NEWSLETTER_DIR or os.path.join(plexpy.DATA_DIR, 'newsletters')
         newsletter_file_fp = os.path.join(newsletter_folder, newsletter_file)
 
         if newsletter_file in os.listdir(newsletter_folder):
@@ -173,4 +185,4 @@ def get_newsletter(newsletter_uuid):
             except OSError as e:
                 logger.error(u"Tautulli NewsletterHandler :: Failed to retrieve newsletter '%s': %s" % (newsletter_uuid, e))
         else:
-            logger.warn(u"Tautulli NewsletterHandler :: Newsletter '%s' file is missing." % newsletter_uuid)
+            logger.warn(u"Tautulli NewsletterHandler :: Newsletter file '%s' is missing." % newsletter_file)

plexpy/newsletters.py

@@ -63,12 +63,13 @@ def available_notification_actions():
     return actions
 
 
-def get_agent_class(agent_id=None, config=None, email_config=None, start_date=None, end_date=None,
+def get_agent_class(newsletter_id=None, agent_id=None, config=None, email_config=None, start_date=None, end_date=None,
                     subject=None, body=None, message=None):
     if str(agent_id).isdigit():
         agent_id = int(agent_id)
 
-        kwargs = {'config': config,
+        kwargs = {'newsletter_id': newsletter_id,
+                  'config': config,
                   'email_config': email_config,
                   'start_date': start_date,
                   'end_date': end_date,
@@ -138,7 +139,8 @@ def get_newsletter_config(newsletter_id=None):
         subject = result.pop('subject')
         body = result.pop('body')
         message = result.pop('message')
-        newsletter_agent = get_agent_class(agent_id=result['agent_id'], config=config, email_config=email_config,
+        newsletter_agent = get_agent_class(newsletter_id=newsletter_id, agent_id=result['agent_id'],
+                                           config=config, email_config=email_config,
                                            subject=subject, body=body, message=message)
     except Exception as e:
         logger.error(u"Tautulli Newsletters :: Failed to get newsletter config options: %s." % e)
@@ -223,7 +225,8 @@ def set_newsletter_config(newsletter_id=None, agent_id=None, **kwargs):
     body = kwargs.pop('body')
     message = kwargs.pop('message')
 
-    agent_class = get_agent_class(agent_id=agent['id'], config=newsletter_config, email_config=email_config,
+    agent_class = get_agent_class(newsletter_id=newsletter_id, agent_id=agent['id'],
+                                  config=newsletter_config, email_config=email_config,
                                   subject=subject, body=body, message=message)
 
     keys = {'id': newsletter_id}
@@ -267,8 +270,11 @@ def send_newsletter(newsletter_id=None, subject=None, body=None, message=None, n
 
 
 def serve_template(templatename, **kwargs):
-    interface_dir = os.path.join(str(plexpy.PROG_DIR), 'data/interfaces/')
-    template_dir = os.path.join(str(interface_dir), plexpy.CONFIG.NEWSLETTER_TEMPLATES)
+    if plexpy.CONFIG.NEWSLETTER_CUSTOM_DIR:
+        template_dir = plexpy.CONFIG.NEWSLETTER_CUSTOM_DIR
+    else:
+        interface_dir = os.path.join(str(plexpy.PROG_DIR), 'data/interfaces/')
+        template_dir = os.path.join(str(interface_dir), plexpy.CONFIG.NEWSLETTER_TEMPLATES)
 
     _hplookup = TemplateLookup(directories=[template_dir], default_filters=['unicode', 'h'])
 
@@ -299,22 +305,26 @@ class Newsletter(object):
                        'time_frame': 7,
                        'time_frame_units': 'days',
                        'formatted': 1,
-                       'notifier_id': 0}
+                       'notifier_id': 0,
+                       'filename': '',
+                       'save_only': 0}
     _DEFAULT_EMAIL_CONFIG = EMAIL().return_default_config()
     _DEFAULT_EMAIL_CONFIG['from_name'] = 'Tautulli Newsletter'
     _DEFAULT_EMAIL_CONFIG['notifier_id'] = 0
     _DEFAULT_SUBJECT = 'Tautulli Newsletter'
     _DEFAULT_BODY = 'View the newsletter here: {newsletter_url}'
     _DEFAULT_MESSAGE = ''
+    _DEFAULT_FILENAME = 'newsletter_{newsletter_uuid}.html'
     _TEMPLATE_MASTER = ''
     _TEMPLATE = ''
 
-    def __init__(self, config=None, email_config=None, start_date=None, end_date=None,
+    def __init__(self, newsletter_id=None, config=None, email_config=None, start_date=None, end_date=None,
                  subject=None, body=None, message=None):
         self.config = self.set_config(config=config, default=self._DEFAULT_CONFIG)
         self.email_config = self.set_config(config=email_config, default=self._DEFAULT_EMAIL_CONFIG)
         self.uuid = generate_newsletter_uuid()
 
+        self.newsletter_id = newsletter_id
         self.start_date = None
         self.end_date = None
 
@@ -346,7 +356,13 @@ class Newsletter(object):
         self.subject = subject or self._DEFAULT_SUBJECT
         self.body = body or self._DEFAULT_BODY
         self.message = message or self._DEFAULT_MESSAGE
+        self.filename = self.config['filename'] or self._DEFAULT_FILENAME
+
+        if not self.filename.endswith('.html'):
+            self.filename += '.html'
+
         self.subject_formatted, self.body_formatted, self.message_formatted = self.build_text()
+        self.filename_formatted = self.build_filename()
 
         self.data = {}
         self.newsletter = None
@@ -421,13 +437,15 @@ class Newsletter(object):
             return False
 
         self._save()
+
+        if self.config['save_only']:
+            return True
+
         return self._send()
 
     def _save(self):
-        newsletter_file = 'newsletter_%s-%s_%s.html' % (self.start_date.format('YYYYMMDD'),
-                                                        self.end_date.format('YYYYMMDD'),
-                                                        self.uuid)
-        newsletter_folder = plexpy.CONFIG.NEWSLETTER_DIR
+        newsletter_file = self.filename_formatted
+        newsletter_folder = plexpy.CONFIG.NEWSLETTER_DIR or os.path.join(plexpy.DATA_DIR, 'newsletters')
         newsletter_file_fp = os.path.join(newsletter_folder, newsletter_file)
 
         # In case the user has deleted it manually
@@ -440,9 +458,9 @@ class Newsletter(object):
                     if '<!-- IGNORE SAVE -->' not in line:
                         n_file.write(line + '\r\n')
 
-            logger.info(u"Tautulli Newsletters :: %s newsletter saved to %s" % (self.NAME, newsletter_file))
+            logger.info(u"Tautulli Newsletters :: %s newsletter saved to '%s'" % (self.NAME, newsletter_file))
         except OSError as e:
-            logger.error(u"Tautulli Newsletters :: Failed to save %s newsletter to %s: %s"
+            logger.error(u"Tautulli Newsletters :: Failed to save %s newsletter to '%s': %s"
                          % (self.NAME, newsletter_file, e))
 
     def _send(self):
@@ -476,9 +494,9 @@ class Newsletter(object):
         date_format = helpers.momentjs_to_arrow(plexpy.CONFIG.DATE_FORMAT)
 
         if plexpy.CONFIG.NEWSLETTER_SELF_HOSTED and plexpy.CONFIG.HTTP_BASE_URL:
-            base_url = plexpy.CONFIG.HTTP_BASE_URL + plexpy.HTTP_ROOT
+            base_url = plexpy.CONFIG.HTTP_BASE_URL + plexpy.HTTP_ROOT + 'newsletter/'
         else:
-            base_url = helpers.get_plexpy_url() + '/'
+            base_url = helpers.get_plexpy_url() + '/newsletter/'
 
         parameters = {
             'server_name': plexpy.CONFIG.PMS_NAME,
@@ -487,8 +505,10 @@ class Newsletter(object):
             'week_number': self.start_date.isocalendar()[1],
             'newsletter_time_frame': self.config['time_frame'],
             'newsletter_time_frame_units': self.config['time_frame_units'],
-            'newsletter_url': base_url + 'newsletter/' + self.uuid,
-            'newsletter_uuid': self.uuid
+            'newsletter_url': base_url + self.uuid,
+            'newsletter_static_url': base_url + 'id/' + str(self.newsletter_id),
+            'newsletter_uuid': self.uuid,
+            'newsletter_id': self.newsletter_id
         }
 
         return parameters
@@ -532,6 +552,23 @@ class Newsletter(object):
 
         return subject, body, message
 
+    def build_filename(self):
+        from notification_handler import CustomFormatter
+        custom_formatter = CustomFormatter()
+
+        try:
+            filename = custom_formatter.format(unicode(self.filename), **self.parameters)
+        except LookupError as e:
+            logger.error(
+                u"Tautulli Newsletter :: Unable to parse parameter %s in newsletter filename. Using fallback." % e)
+            filename = unicode(self._DEFAULT_FILENAME).format(**self.parameters)
+        except Exception as e:
+            logger.error(
+                u"Tautulli Newsletter :: Unable to parse custom newsletter subject: %s. Using fallback." % e)
+            filename = unicode(self._DEFAULT_FILENAME).format(**self.parameters)
+
+        return filename
+
     def return_config_options(self):
         return self._return_config_options()
 
@@ -695,7 +732,7 @@ class RecentlyAdded(Newsletter):
         artists = recently_added.get('artist', [])
         albums = [a for artist in artists for a in artist['album']]
 
-        if self.is_preview or plexpy.CONFIG.NEWSLETTER_SELF_HOSTED:
+        if self.is_preview or helpers.get_img_service(include_self=True) == 'self-hosted':
             for item in movies + shows + albums:
                 if item['media_type'] == 'album':
                     height = 150
@@ -717,7 +754,7 @@ class RecentlyAdded(Newsletter):
                 item['poster_url'] = ''
                 item['art_url'] = ''
 
-        else:
+        elif helpers.get_img_service():
             # Upload posters and art to image hosting service
             for item in movies + shows + albums:
                 if item['media_type'] == 'album':
@@ -800,4 +837,4 @@ class RecentlyAdded(Newsletter):
              }
         ]
 
-        return config_options + additional_config
+        return additional_config + config_options

plexpy/notification_handler.py

@@ -1098,7 +1098,10 @@ def get_img_info(img=None, rating_key=None, title='', width=1000, height=1500,
 
     service = helpers.get_img_service()
 
-    if service == 'cloudinary':
+    if service is None:
+        return img_info
+
+    elif service == 'cloudinary':
         if fallback == 'cover':
             w, h = 1000, 1000
         elif fallback == 'art':
@@ -1134,7 +1137,7 @@ def get_img_info(img=None, rating_key=None, title='', width=1000, height=1500,
 
     elif not database_img_info and img:
         pms_connect = pmsconnect.PmsConnect()
-        result = pms_connect.get_image(**image_info)
+        result = pms_connect.get_image(refresh=True, **image_info)
 
         if result and result[0]:
             img_url = delete_hash = ''

plexpy/notifiers.py

@@ -1310,26 +1310,30 @@ class EMAIL(Notifier):
 
         recipients = self.config['to'] + self.config['cc'] + self.config['bcc']
 
+        success = False
+        mailserver = smtplib.SMTP(self.config['smtp_server'], self.config['smtp_port'])
+
         try:
-            mailserver = smtplib.SMTP(self.config['smtp_server'], self.config['smtp_port'])
+            mailserver.ehlo()
 
             if self.config['tls']:
                 mailserver.starttls()
-
-            mailserver.ehlo()
+                mailserver.ehlo()
 
             if self.config['smtp_user']:
                 mailserver.login(str(self.config['smtp_user']), str(self.config['smtp_password']))
 
             mailserver.sendmail(self.config['from'], recipients, msg.as_string())
-            mailserver.quit()
-
-            logger.info(u"Tautulli Notifiers :: {name} notification sent.".format(name=self.NAME))
-            return True
+            success = True
 
         except Exception as e:
             logger.error(u"Tautulli Notifiers :: {name} notification failed: {e}".format(name=self.NAME, e=e))
-            return False
+
+        finally:
+            mailserver.quit()
+            logger.info(u"Tautulli Notifiers :: {name} notification sent.".format(name=self.NAME))
+
+        return success
 
     def get_user_emails(self):
         emails = {u['email']: u['friendly_name'] for u in users.Users().get_users() if u['email']}

plexpy/version.py

@@ -1,2 +1,2 @@
 PLEXPY_BRANCH = "beta"
-PLEXPY_RELEASE_VERSION = "v2.1.4"
+PLEXPY_RELEASE_VERSION = "v2.1.5-beta"

plexpy/webserve.py

@@ -2755,7 +2755,9 @@ class WebInterface(object):
             "tvmaze_lookup": checked(plexpy.CONFIG.TVMAZE_LOOKUP),
             "show_advanced_settings": plexpy.CONFIG.SHOW_ADVANCED_SETTINGS,
             "newsletter_dir": plexpy.CONFIG.NEWSLETTER_DIR,
-            "newsletter_self_hosted": checked(plexpy.CONFIG.NEWSLETTER_SELF_HOSTED)
+            "newsletter_self_hosted": checked(plexpy.CONFIG.NEWSLETTER_SELF_HOSTED),
+            "newsletter_static_url": checked(plexpy.CONFIG.NEWSLETTER_STATIC_URL),
+            "newsletter_custom_dir": plexpy.CONFIG.NEWSLETTER_CUSTOM_DIR
         }
 
         return serve_template(templatename="settings.html", title="Settings", config=config, kwargs=kwargs)
@@ -2777,7 +2779,7 @@ class WebInterface(object):
             "allow_guest_access", "cache_images", "http_proxy", "http_basic_auth", "notify_concurrent_by_ip",
             "history_table_activity", "plexpy_auto_update",
             "themoviedb_lookup", "tvmaze_lookup", "http_plex_admin",
-            "newsletter_self_hosted"
+            "newsletter_self_hosted", "newsletter_static_url"
         ]
         for checked_config in checked_configs:
             if checked_config not in kwargs:
@@ -5661,10 +5663,18 @@ class WebInterface(object):
                     except NotFound:
                         return
 
+                cherrypy.response.headers['Cache-Control'] = 'max-age=2592000'  # 30 days
                 return self.image(args[1], refresh=True)
 
-            newsletter_uuid = args[0]
-            newsletter = newsletter_handler.get_newsletter(newsletter_uuid=newsletter_uuid)
+            if plexpy.CONFIG.NEWSLETTER_STATIC_URL and len(args) >= 2 and args[0] == 'id':
+                newsletter_id = args[1]
+                newsletter_uuid = None
+            else:
+                newsletter_id = None
+                newsletter_uuid = args[0]
+
+            newsletter = newsletter_handler.get_newsletter(newsletter_uuid=newsletter_uuid,
+                                                           newsletter_id=newsletter_id)
             return newsletter
 
     @cherrypy.expose
@@ -5683,7 +5693,8 @@ class WebInterface(object):
             newsletter = newsletters.get_newsletter_config(newsletter_id=newsletter_id)
 
             if newsletter:
-                newsletter_agent = newsletters.get_agent_class(agent_id=newsletter['agent_id'],
+                newsletter_agent = newsletters.get_agent_class(newsletter_id=newsletter_id,
+                                                               agent_id=newsletter['agent_id'],
                                                                config=newsletter['config'],
                                                                start_date=start_date,
                                                                end_date=end_date,