Merge pull request #368 from divio/feature/update-notification

Added working draft of update notification template code

Author: vxsx

README.rst

@@ -27,6 +27,16 @@ Look at the source of ``templates/admin/base_site.html`` and override the templa
 For example, you can add your own CSS in ``templates/admin/inc/extrastyle.html``.
 
 
+Settings
+========
+
+* ``CMS_ENABLE_UPDATE_CHECK = True``
+  Set to ``False`` to disable the update notification.
+* ``CMS_UPDATE_CHECK_TYPE = ('minor')``
+  Set to ``('patch')`` to get only patch notifications.
+  (minor = 3.x.x, patch = 3.4.x)
+
+
 Compiling CSS
 =============
 

djangocms_admin_style/sass/components/_cms-update.scss

@@ -0,0 +1,18 @@
+.cms-update-message {
+    position: relative;
+    margin-bottom: 30px;
+    padding: 10px 20px 10px 10px;
+    border: 1px solid $color-primary;
+    border-radius: 4px;
+    background-color: rgba($color-primary, 0.1);
+
+    .close {
+        position: absolute;
+        top: 0;
+        right: 0;
+        line-height: 20px;
+        text-align: center;
+        width: 20px;
+        height: 20px;
+    }
+}

djangocms_admin_style/sass/components/_tables.scss

@@ -374,3 +374,11 @@
         }
     }
 }
+
+.change-list table.navigator-table {
+    tbody {
+        td {
+            vertical-align: middle !important;
+        }
+    }
+}

djangocms_admin_style/sass/djangocms-admin.scss

@@ -30,6 +30,7 @@
 @import "components/footer";
 @import "components/shortcuts";
 @import "components/drag-and-drop";
+@import "components/cms-update";
 
 //##############################################################################
 // IMPORT MOBILE

djangocms_admin_style/static/djangocms_admin_style/css/djangocms-admin.css

@@ -4,6 +4,7 @@ var initDragAndDropSupportForTreeBeard = require('./modules/drag-touch-support')
 var initUIFixes = require('./modules/ui-fixes');
 var initRelatedWidgetWrappers = require('./modules/related-widget-wrapper');
 var initToolbarDropdown = require('./modules/toolbar-dropdown');
+var initUpdateNotification = require('./modules/update-notification');
 
 // this attaches to global jQuery because
 // we need to touch punch the things like sortedm2m
@@ -18,4 +19,5 @@ $(function () {
     initUIFixes();
     initRelatedWidgetWrappers();
     initToolbarDropdown();
+    initUpdateNotification();
 });

djangocms_admin_style/static/djangocms_admin_style/js/base-admin.js

@@ -32,6 +32,10 @@ function init() {
     var menuItem = document.getElementsByClassName('menu-item')[0];
     var html = document.getElementsByTagName('html')[0];
 
+    if (!submenu || !menuItem) {
+        return;
+    }
+
     menuItem.addEventListener('click', function (event) {
         var evt = event || window.event;
 

djangocms_admin_style/static/djangocms_admin_style/js/dist/bundle.adminstyle.min.js

@@ -0,0 +1,175 @@
+var $ = require('jquery');
+var Cookies = require('js-cookie');
+var RELEASES_URL = 'https://releases.django-cms.org/';
+var MAIN_COOKIE_EXPIRATION = 365; // ~1 year
+var REQUEST_COOKIE_EXPIRATION = 14; // check only every two weeks
+
+/**
+ * @function getLatestVersionData
+ * @private
+ * @param {Object} data additional data to send as get params
+ * @returns {$.Deferred}
+ */
+function getLatestVersionData(data) {
+    return $.ajax({
+        url: RELEASES_URL,
+        data: data
+    });
+}
+
+/**
+ * @function compareVersion
+ * @param {String} a
+ * @param {String} b
+ * @returns {Number}
+ */
+function compareVersion(a, b) {
+    var i;
+    var cmp;
+    var len;
+    var re = /(\.0)+[^\.]*$/;
+
+    a = (a + '').replace(re, '').split('.'); // eslint-disable-line no-param-reassign
+    b = (b + '').replace(re, '').split('.'); // eslint-disable-line no-param-reassign
+    len = Math.min(a.length, b.length);
+    for (i = 0; i < len; i++) {
+        cmp = parseInt(a[i], 10) - parseInt(b[i], 10);
+
+        if (cmp !== 0) {
+            return cmp;
+        }
+    }
+
+    return a.length - b.length;
+}
+
+/**
+ * is first version greater than second version?
+ *
+ * @function greaterThanVersion
+ * @param {String} a
+ * @param {String} b
+ * @returns {Boolean} true if a > b or a === b but a is a dev/rc version
+ */
+function greaterThanVersion(a, b) {
+    var cmp = compareVersion(a, b);
+
+    if (cmp > 0) {
+        return true;
+    } else if (cmp === 0) {
+        if (b.match(/[^\.\d]+/)) {
+            return true;
+        }
+        return false;
+    }
+
+    return false;
+}
+
+/**
+ * @function injectMessage
+ * @param {Object} versionObject
+ * @param {String} versionObject.version
+ * @param {String} versionObject.url
+ * @param {String} checkType patch or minor/major
+ */
+function injectMessage(versionObject, checkType) {
+    var messageTmpl = $($('#cms-update-notification').html());
+
+    messageTmpl.find('.js-latest-version').text(versionObject.version);
+    messageTmpl.find('.js-release-notes-link').attr('href', versionObject.url);
+    messageTmpl.find('.close').on('click', function (e) {
+        e.preventDefault();
+
+        Cookies.set(
+            'cms_upgrade_notification_closed',
+            JSON.stringify({
+                version: versionObject.version,
+                type: checkType
+            }),
+            {
+                expires: MAIN_COOKIE_EXPIRATION
+            }
+        );
+
+        Cookies.set(
+            'cms_upgrade_notification_closed_recently',
+            true,
+            {
+                expires: REQUEST_COOKIE_EXPIRATION
+            }
+        );
+
+        messageTmpl.slideUp('fast', function () {
+            messageTmpl.remove();
+        });
+    });
+
+    messageTmpl.prependTo('#content').slideDown('fast');
+}
+
+/**
+ * @function shouldShowMessage
+ * @private
+ * @param {Object} versionObj
+ * @param {String} versionObj.version
+ * @param {String} currentVersion
+ * @param {String} checkType
+ * @returns {Boolean}
+ */
+function shouldShowMessage(versionObj, currentVersion, checkType) {
+    var cookie = Cookies.get('cms_upgrade_notification_closed');
+
+    if (cookie) {
+        cookie = JSON.parse(cookie);
+    }
+
+    if (cookie && cookie.type === checkType && cookie.version === versionObj.version) {
+        return false;
+    }
+
+    return greaterThanVersion(versionObj.version, currentVersion);
+}
+
+/**
+ * @function init
+ * @public
+ */
+function init() {
+    var metaVersion = $('meta[name="djangocms_version"]');
+
+    if (!metaVersion.length || Cookies.get('cms_upgrade_notification_closed_recently')) {
+        return;
+    }
+
+    var currentVersion = metaVersion.attr('content');
+    var checkType = $('meta[name="djangocms_version_check_type"]').attr('content');
+
+    getLatestVersionData({
+        version: currentVersion,
+        type: checkType
+    }).done(function (response) {
+        if (typeof response === 'string') {
+            try {
+                // eslint-disable-next-line
+                response = JSON.parse(response);
+            } catch (e) { }
+        }
+
+        var versionObj = response.latest;
+
+        if (checkType === 'patch') {
+            response.patches.forEach(function (patch) {
+                if (patch.version.match(new RegExp('^' + currentVersion.replace(/\.[^\.]+$/, '')))) {
+                    versionObj = patch;
+                }
+            });
+        }
+
+        if (shouldShowMessage(versionObj, currentVersion, checkType)) {
+            injectMessage(versionObj, checkType);
+        }
+    });
+}
+
+module.exports = init;