X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=notmuch-to-html;h=498921565379514b59e18ce83d532e8dd0d895d6;hb=158211a970cc971fda6f236ce0bcbcce6ba6dad8;hp=c3de6969f2cfbd0674f8efa81f587a00cdb7bd2d;hpb=bcc677a43daf981823be4ef3814567a9b9637c93;p=obsolete%2Fnotmuch-to-html

diff --git a/notmuch-to-html b/notmuch-to-html
index c3de696..4989215 100755
--- a/notmuch-to-html
+++ b/notmuch-to-html
@@ -1,10 +1,26 @@
 #!/usr/bin/python
 #
+# Generate an HTML page with the result of one or more notmuch
+# searches, (with links to gmane views of each email if available).
+#
 # Copyright (c) 2011-2012 David Bremner <david@tethera.net>
-# License: Same as notmuch
+#
 # dependencies
 #       - python 2.6 for json
 #       - argparse; either python 2.7, or install separately
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see http://www.gnu.org/licenses/ .
 
 from __future__ import print_function
 from __future__ import unicode_literals
@@ -29,6 +45,22 @@ import xml.sax.saxutils
 _ENCODING = 'UTF-8'
 _PAGES = {}
 
+DEFAULT_CONFIG='''
+{{
+    "meta": {{
+        "title": "Page title",
+        "blurb": "Page description"
+    }},
+
+    "views": [
+	{{
+	    "title": "View title",
+	    "comment": "View description",
+	    "query": [ "{query}" ]
+	}}
+    ]
+}}'''
+
 
 if not hasattr(collections, 'OrderedDict'):  # Python 2.6 or earlier
     class _OrderedDict (dict):
@@ -49,27 +81,11 @@ if not hasattr(collections, 'OrderedDict'):  # Python 2.6 or earlier
     collections.OrderedDict = _OrderedDict
 
 
-def read_config(path=None, encoding=None):
+def read_config(path, encoding=None):
     "Read config from json file"
     if not encoding:
         encoding = _ENCODING
-    if path:
-        fp = open(path)
-    else:
-        nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug'))
-
-        # read only the first line from the pipe
-        sha1_bytes = subprocess.Popen(
-            ['git', '--git-dir', nmbhome, 'show-ref', '-s', 'config'],
-            stdout=subprocess.PIPE).stdout.readline()
-        sha1 = sha1_bytes.decode(encoding).rstrip()
-
-        fp_byte_stream = subprocess.Popen(
-            ['git', '--git-dir', nmbhome, 'cat-file', 'blob',
-             sha1+':status-config.json'],
-            stdout=subprocess.PIPE).stdout
-        fp = codecs.getreader(encoding=encoding)(stream=fp_byte_stream)
-
+    fp = open(path)
     return json.load(fp)
 
 
@@ -188,11 +204,11 @@ class HtmlPage (Page):
             stream.write(view['comment'])
             stream.write('\n')
         for line in [
-                'The view is generated from the following query:',
+                '<p>This view is generated from the following query:',
                 '</p>',
                 '<p>',
                 '  <code>',
-                view['query-string'],
+                'notmuch search ' + view['query-string'],
                 '  </code>',
                 '</p>',
                 ]:
@@ -242,16 +258,27 @@ class HtmlPage (Page):
 parser = argparse.ArgumentParser()
 parser.add_argument('--text', help='output plain text format',
                     action='store_true')
-parser.add_argument('--config', help='load config from given file',
-                    metavar='PATH')
+group = parser.add_mutually_exclusive_group()
+group.add_argument('--config', help='path to configuration file',
+                   metavar='PATH')
+group.add_argument('--query', help='path to configuration file',
+                   metavar='PATH')
 parser.add_argument('--list-views', help='list views',
                     action='store_true')
-parser.add_argument('--get-query', help='get query for view',
-                    metavar='VIEW')
 
 args = parser.parse_args()
 
-config = read_config(path=args.config)
+if (args.config):
+    config = read_config(path=args.config)
+elif (args.query):
+    config = json.loads(DEFAULT_CONFIG.format(query=args.query))
+else:
+    print ('''To use notmuch-to-html, you need to provide a notmuch query. Try:
+
+	notmuch-to-html --query=tag:inbox
+
+Or 'notmuch-to-html --help' for additional options.''')
+    exit (0)
 
 _PAGES['text'] = Page()
 _PAGES['html'] = HtmlPage(
@@ -296,29 +323,25 @@ _PAGES['html'] = HtmlPage(
 </head>
 <body>
 <h2>{title}</h2>
-<p>
-Generated: {date}<br />
 {blurb}
 </p>
 <h3>Views</h3>
-'''.format(date=datetime.datetime.utcnow().date(),
-           title=config['meta']['title'],
+'''.format(title=config['meta']['title'],
            blurb=config['meta']['blurb'],
            encoding=_ENCODING,
            inter_message_padding='0.25em',
            border_radius='0.5em'),
-    footer='</body>\n</html>\n',
+    footer='''<hr>
+<p>Generated: {date} courtesy of <a href="http://notmuchmail.org">notmuch</a> and <a href="http://git.cworth.org/git/notmuch-to-html">notmuch-to-html</a>.
+</body>
+</html>
+'''.format(date=datetime.datetime.utcnow().date())
     )
 
 if args.list_views:
     for view in config['views']:
         print(view['title'])
     sys.exit(0)
-elif args.get_query != None:
-    for view in config['views']:
-        if args.get_query == view['title']:
-            print(' and '.join(view['query']))
-    sys.exit(0)
 else:
     # only import notmuch if needed
     import notmuch
@@ -330,3 +353,12 @@ else:
 
 db = notmuch.Database(mode=notmuch.Database.MODE.READ_ONLY)
 page.write(database=db, views=config['views'])
+
+if (args.query):
+    print ('''To customize the output use 'notmuch-to-html --config=CONFIG_FILE' after
+placing the following content into CONFIG_FILE (note that you can add
+additional views with their own queries):
+
+
+''', file=sys.stderr)
+    print (json.dumps(config, indent=4, separators=(',',':')), file=sys.stderr)