diff options
Diffstat (limited to 'jt')
| -rwxr-xr-x | jt | 360 |
1 files changed, 1 insertions, 359 deletions
@@ -15,365 +15,7 @@ # along with this program. If not, see <http://www.gnu.org/licenses/>. -import cliapp -import os -import shutil -import string -import time - import jtlib -class Command(object): - - def __init__(self, app): - self._app = app - - def run(self, args): - raise NotImplementedError() - - -class NewCommand(Command): - - _default_new_note_template = '''\ -[[!meta title="%(title)s"]] -[[!tag ]] -[[!meta date="%(date)s"]] -%(topiclink)s - -''' - - def run(self, args): - self._check_args_and_settings(args) - - topic = self._app.settings['topic'] - values = { - 'title': args[0], - 'date': time.strftime('%Y-%m-%d %H:%M', self._app.now_tuple), - 'topiclink': self._get_topic_link(topic), - } - - drafts_dir = jtlib.DraftsDirectory(self._app.drafts_dir()) - drafts_dir.create_if_missing() - draft_id = drafts_dir.create_draft( - self._get_new_note_template() % values) - self._app.edit_file(drafts_dir.get_draft_pathname(draft_id)) - - def _check_args_and_settings(self, args): - if not args: - raise cliapp.AppException('Usage: journal-note new TITLE') - - self._app.settings.require('source') - topic = self._app.settings['topic'] - if topic and not self._topic_page_exists(topic): - raise cliapp.AppException('Topic %s does not exist yet' % topic) - - def _topic_page_exists(self, topic): - pathname = os.path.join(self._app.settings['source'], topic + '.mdwn') - return os.path.exists(pathname) - - def _get_topic_link(self, topic): - if topic: - return '[[!meta link="%s"]]' % topic - else: - return '' - - def _get_new_note_template(self): - filename = self._app.settings['new-note-template'] - if filename: - with open(filename) as f: - return f.read() - else: - return self._default_new_note_template - - -class ListCommand(Command): - - def run(self, args): - drafts_dir = jtlib.DraftsDirectory(self._app.drafts_dir()) - for draft_id, _ in drafts_dir.get_drafts(): - print draft_id, drafts_dir.get_draft_title(draft_id) - - -class EditCommand(Command): - - def run(self, args): - if len(args) > 1: - raise cliapp.AppException('Must be given at most one draft ID') - drafts_dir = jtlib.DraftsDirectory(self._app.drafts_dir()) - _, pathname = self._app.choose_draft(drafts_dir, args) - self._app.edit_file(pathname) - - -class AttachCommand(Command): - - def run(self, args): - if len(args) < 2: - raise cliapp.AppException('Usage: journal-note attach ID file...') - - drafts_dir = jtlib.DraftsDirectory(self._app.drafts_dir()) - dirname = drafts_dir.get_draft_attachments_dirname(args[0]) - if not os.path.exists(dirname): - os.mkdir(dirname) - for filename in args[1:]: - shutil.copy(filename, dirname) - - -class RemoveCommand(Command): - - def run(self, args): - if not args: - raise cliapp.AppException('Usage: journal-note remove ID') - drafts_dir = jtlib.DraftsDirectory(self._app.drafts_dir()) - drafts_dir.remove_draft(args[0]) - - -class FinishCommand(Command): - - def run(self, args): - drafts_dir = jtlib.DraftsDirectory(self._app.drafts_dir()) - - draft_id, draft_mdwn = self._app.choose_draft(drafts_dir, args) - draft_attch = drafts_dir.get_draft_attachments_dirname(draft_id) - - title = drafts_dir.get_draft_title(draft_id) - if not title: - raise Exception("%s has no title" % draft_mdwn) - - pub_attch = os.path.join( - self._published_dir(), - self._summarise_title(title)) - pub_mdwn = pub_attch + '.mdwn' - - if os.path.exists(pub_mdwn): - raise cliapp.AppException('%s already exists' % pub_mdwn) - - self._publish_draft(draft_mdwn, draft_attch, pub_mdwn, pub_attch) - - if self._app.settings['git']: - if os.path.exists(pub_attch): - self._commit_to_git([pub_mdwn, pub_attch]) - else: - self._commit_to_git([pub_mdwn]) - if self._app.settings['push']: - self._push_git() - - def _published_dir(self): - subdir = time.strftime('notes/%Y/%m/%d', self._app.now_tuple) - return os.path.join(self._app.settings['source'], subdir) - - def _summarise_title(self, title): - basename = '' - acceptable = set(string.ascii_letters + string.digits + '-_') - for c in title.lower(): - if c in acceptable: - basename += c - elif not basename.endswith('_'): - basename += '_' - return basename - - def _publish_draft(self, draft_mdwn, draft_attch, pub_mdwn, pub_attch): - parent_dir = os.path.dirname(pub_mdwn) - if not os.path.exists(parent_dir): - os.makedirs(parent_dir) - os.rename(draft_mdwn, pub_mdwn) - if os.path.exists(draft_attch): - os.rename(draft_attch, pub_attch) - - def _commit_to_git(self, pathnames): - jtlib.commit_to_git(self._app.settings['source'], pathnames) - - def _push_git(self): - jtlib.push_git(self._app.settings['source']) - - -class NewTopicCommand(Command): - - def run(self, args): - if len(args) != 2: - raise cliapp.AppException( - 'Must be given two args (page path, title) (%r)' % args) - - pathname = self._topic_pathname(args[0]) - self._create_topic_page(pathname, args[1]) - jtlib.commit_to_git(self._app.settings['source'], [pathname]) - if self._app.settings['push']: - jtlib.push_git(self._app.settings['source']) - - def _topic_pathname(self, page_path): - return os.path.join(self._app.settings['source'], page_path + '.mdwn') - - def _create_topic_page(self, pathname, title): - dirname = os.path.dirname(pathname) - if not os.path.exists(dirname): - os.makedirs(dirname) - - template = '''\ -[[!meta title="%(title)s"]] - - - -[[!inline pages="link(.)" archive=yes reverse=yes trail=yes]] -''' - - with open(pathname, 'w') as f: - f.write(template % {'title': title}) - - -class NewPersonCommand(Command): - - def run(self, args): - if len(args) != 1: - raise cliapp.AppException( - 'Need the name of a person (in Last, First form)') - - def normalise(name): - s = name.lower() - s = ' '.join(s.split(',')) - s = '.'.join(s.split()) - return s - - name = args[0] - basename = normalise(name) - pathname = os.path.join( - self._app.settings['source'], 'people', basename + '.mdwn') - - if os.path.exists(pathname): - raise cliapp.AppException('File %s already exists' % pathname) - - template = '''\ -[[!meta title="%(name)s"]] - -[[!inline archive=yes pages="link(.)"]] -''' - - with open(pathname, 'w') as f: - f.write( - template % - { - 'name': name, - 'basename': basename, - }) - - -class JournalTool(cliapp.Application): - - cmd_synopsis = { - 'attach': 'DRAFT-ID [FILE]...', - 'edit': '[DRAFT-ID]', - 'finish': '[DRAFT-ID]', - 'list': '', - 'new': 'TITLE', - 'remove': 'DRAFT-ID', - } - - def add_settings(self): - self.settings.string( - ['source'], - 'use journal source tree in DIR', - metavar='DIR') - - self.settings.boolean( - ['git'], - 'add entries to git automatically', - default=True) - - self.settings.string( - ['editor'], - 'editor to launch for journal entries. Must include %s to ' - 'indicate where the filename goes', - default='sensible-editor %s') - - self.settings.boolean( - ['push'], - 'push finished articles with git?') - - self.settings.string( - ['topic'], - 'new entry belongs to TOPIC', - metavar='TOPIC') - - self.settings.string( - ['new-note-template'], - 'use FILE as the template for new journal notes', - metavar='FILE') - - self.settings.string( - ['pretend-time'], - 'pretend that the time is NOW (form: YYYY-MM-DD HH:MM:DD form)', - metavar='NOW') - - def process_args(self, args): - if self.settings['pretend-time']: - self.now_tuple = time.strptime( - self.settings['pretend-time'], '%Y-%m-%d %H:%M:%S') - else: - self.now_tuple = time.localtime() - cliapp.Application.process_args(self, args) - - def cmd_new(self, args): - '''Create a new journal entry draft.''' - NewCommand(self).run(args) - - def cmd_list(self, args): - '''List journal entry drafts.''' - ListCommand(self).run(args) - - def cmd_edit(self, args): - '''Edit a draft journal entry.''' - EditCommand(self).run(args) - - def cmd_attach(self, args): - '''Attach files to a journal entry draft.''' - AttachCommand(self).run(args) - - def cmd_remove(self, args): - '''Remove a draft.''' - RemoveCommand(self).run(args) - - def cmd_finish(self, args): - '''Publish a draft journal entry.''' - FinishCommand(self).run(args) - - def cmd_new_topic(self, args): - '''Create a new topic page.''' - NewTopicCommand(self).run(args) - - def cmd_new_person(self, args): - '''Create a page to list all notes referring to a person. - - This is probably only useful to Lars's personal journal. - - ''' - - NewPersonCommand(self).run(args) - - def drafts_dir(self): - return os.path.join(self.settings['source'], 'drafts') - - def edit_file(self, pathname): - safe_pathname = cliapp.shell_quote(pathname) - cmdline = ['sh', '-c', self.settings['editor'] % safe_pathname] - self.runcmd(cmdline, stdin=None, stdout=None, stderr=None) - - def choose_draft(self, drafts_dir, args): - if len(args) == 0: - drafts = list(drafts_dir.get_drafts()) - if len(drafts) == 1: - draft_id, filename = drafts[0] - return draft_id, filename - elif len(drafts) == 0: - raise cliapp.AppException('No drafts to choose from') - else: - raise cliapp.AppException( - 'Cannot choose entry draft automatically') - elif len(args) == 1: - pathname = drafts_dir.get_draft_pathname(args[0]) - if not os.path.exists(pathname): - raise cliapp.AppException('draft %s does not exist' % args[0]) - return args[0], pathname - elif len(args) > 1: - raise cliapp.AppException('Must give at most one draft number') - - -JournalTool(version=jtlib.__version__).run() +jtlib.JournalTool(version=jtlib.__version__).run() |