Merge pull request #1741 from getnikola/status-command

New status command

CHANGES.txt

@@ -4,13 +4,15 @@ New in master
 Features
 --------
 
+* New `nikola status` command
 * Cleaner formatting of HTML output
 * Allowing category hierarchies via new option CATEGORY_ALLOW_HIERARCHIES
   (Issue #1520)
 
 Bugfixes
 --------
 
+* github_deploy records lastdeploy timestamp like regular deploy
 * Use a global directory for gallery images, ignoring translations (Issue #1726)
 * The post-list directive only triggers rebuilds if timeline changes (Issue #1688)
 * Don’t check the same remote URL more than once (Issue #1732)

nikola/plugins/command/github_deploy.py

@@ -25,14 +25,16 @@
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 from __future__ import print_function
+from datetime import datetime
+import io
 import os
 import subprocess
 import sys
 from textwrap import dedent
 
 from nikola.plugin_categories import Command
 from nikola.plugins.command.check import real_scan_files
-from nikola.utils import get_logger, req_missing
+from nikola.utils import get_logger, req_missing, makedirs, unicode_str
 from nikola.__main__ import main
 from nikola import __version__
 
@@ -119,3 +121,12 @@ def _commit_and_push(self):
                 'returned {1}'.format(e.cmd, e.returncode)
             )
             sys.exit(e.returncode)
+
+        self.logger.info("Successful deployment")
+
+        # Store timestamp of successful deployment
+        timestamp_path = os.path.join(self.site.config["CACHE_FOLDER"], "lastdeploy")
+        new_deploy = datetime.utcnow()
+        makedirs(self.site.config["CACHE_FOLDER"])
+        with io.open(timestamp_path, "w+", encoding="utf8") as outf:
+            outf.write(unicode_str(new_deploy.isoformat()))

nikola/plugins/command/status.plugin

@@ -0,0 +1,9 @@
+[Core]
+Name = status
+Module = status
+
+[Documentation]
+Author = Daniel Aleksandersen
+Version = 1.0
+Website = https://getnikola.com
+Description = Site status

nikola/plugins/command/status.py

@@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*-
+
+# Copyright © 2012-2015 Roberto Alsina and others.
+
+# Permission is hereby granted, free of charge, to any
+# person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the
+# Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the
+# Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice
+# shall be included in all copies or substantial portions of
+# the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+# OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+from __future__ import print_function
+import io
+import os
+from datetime import datetime
+from dateutil.tz import gettz, tzlocal
+
+from nikola.plugin_categories import Command
+
+
+class CommandDeploy(Command):
+    """ Site status. """
+    name = "status"
+
+    doc_purpose = "display site status"
+    doc_description = "Show information about the posts and site deployment."
+    logger = None
+
+    def _execute(self, command, args):
+
+        self.site.scan_posts()
+
+        timestamp_path = os.path.join(self.site.config["CACHE_FOLDER"], "lastdeploy")
+
+        try:
+            with io.open(timestamp_path, "r", encoding="utf8") as inf:
+                last_deploy = datetime.strptime(inf.read().strip(), "%Y-%m-%dT%H:%M:%S.%f")
+                last_deploy_offset = datetime.utcnow() - last_deploy
+        except (IOError, Exception):
+            print("It does not seem like you’ve ever deployed the site (or cache missing).")
+
+        if last_deploy:
+
+            fmod_since_deployment = 0
+            for root, dirs, files in os.walk(self.site.config["OUTPUT_FOLDER"], followlinks=True):
+                if not dirs and not files:
+                    continue
+                for fname in files:
+                    fpath = os.path.join(root, fname)
+                    fmodtime = datetime.fromtimestamp(os.stat(fpath).st_mtime)
+                    if fmodtime.replace(tzinfo=tzlocal()) > last_deploy.replace(tzinfo=gettz("UTC")).astimezone(tz=tzlocal()):
+                        fmod_since_deployment = fmod_since_deployment + 1
+
+            if fmod_since_deployment > 0:
+                print("{0} output files modified since last deployment {1} ago.".format(str(fmod_since_deployment), self.human_time(last_deploy_offset)))
+            else:
+                print("Last deployment {0} ago.".format(self.human_time(last_deploy_offset)))
+
+        posts_count = len(self.site.all_posts)
+        posts_drafts = 0
+        posts_scheduled = 0
+        nearest_scheduled_offset = None
+
+        for post in self.site.all_posts:
+            if post.is_draft:
+                posts_drafts = posts_drafts + 1
+            if post.publish_later:
+                posts_scheduled = posts_scheduled + 1
+                post_due_offset = post.date - datetime.utcnow().replace(tzinfo=gettz("UTC"))
+                if (nearest_scheduled_offset is None) or (post_due_offset.seconds < nearest_scheduled_offset.seconds):
+                    nearest_scheduled_offset = post_due_offset
+
+        if posts_scheduled > 0 and nearest_scheduled_offset is not None:
+            print("{0} to next scheduled post.".format(self.human_time(nearest_scheduled_offset)))
+        print("{0} posts in total, {1} scheduled, and {2} drafts.".format(posts_count, posts_scheduled, posts_drafts))
+
+    def human_time(self, dt):
+        days = dt.days
+        hours = dt.seconds / 60 // 60
+        minutes = dt.seconds / 60 - (hours * 60)
+        if days > 0:
+            return "{0:.0f} days and {1:.0f} hours".format(days, hours)
+        elif hours > 0:
+            return "{0:.0f} hours and {1:.0f} minutes".format(hours, minutes)
+        elif minutes:
+            return "{0:.0f} minutes".format(minutes)
+        return False