ofexport.py

'''
Copyright 2013 Paul Sidnell

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
'''

import os
import codecs
import getopt
import sys
from treemodel import traverse_list
from omnifocus import build_model, find_database
from datetime import date
from of_to_tp import PrintTaskpaperVisitor
from of_to_text import PrintTextVisitor
from of_to_md import PrintMarkdownVisitor
from of_to_opml import PrintOpmlVisitor
from of_to_html import PrintHtmlVisitor
from visitors import FolderNameFilterVisitor, ProjectNameFilterVisitor, ProjectFlaggedFilterVisitor, ProjectDueFilterVisitor, ProjectStartFilterVisitor, ContextNameFilterVisitor, TaskDueFilterVisitor, TaskNameFilterVisitor, TaskStartFilterVisitor, TaskCompletionFilterVisitor, ProjectCompletionFilterVisitor, TaskCompletionSortingVisitor, TaskFlaggedFilterVisitor, PruningFilterVisitor, FlatteningVisitor

VERSION = "1.0.2 (2013-04-12)" 
     
def print_structure (visitor, root_projects_and_folders, root_contexts, project_mode):
    if project_mode:
        traverse_list (visitor, root_projects_and_folders)
    else:
        traverse_list (visitor, root_contexts)

class CustomPrintTaskpaperVisitor (PrintTaskpaperVisitor):
    pass
    def tags (self, item):
        if item.date_completed != None:
            return item.date_completed.strftime(" @%Y-%m-%d-%a")
        else:
            return ""
        
def print_help ():
    print 'Version ' + VERSION
    print 
    print 'Usage:'
    print
    print 'ofexport [options...] -o file_name'
    print
    print
    print 'options:'
    print '  -h,-?,--help'
    print '  -C: context mode (as opposed to project mode)'
    print '  -o file_name: the output file name, must end in a recognised suffix - see documentation'
    print '  --open: open the output file with the registered application (if one is installed)'
    print
    print 'filters:'
    
    print '  --pi regexp: include projects matching regexp'
    print '  --pe regexp: exclude projects matching regexp'
    
    print '  --pci regexp: include projects with completion matching regexp'
    print '  --pce regexp: exclude projects with completion matching regexp'
    
    print '  --pdi regexp: include projects with due matching regexp'
    print '  --pde regexp: exclude projects with due matching regexp'
    
    print '  --psi regexp: include projects with start matching regexp'
    print '  --pse regexp: exclude projects with start matching regexp'
    
    print '  --pfi: include flagged projects'
    print '  --pfe: exclude flagged projects'
    
    print '  --fi regexp: include folders matching regexp'
    print '  --fe regexp: exclude folders matching regexp'
    
    print '  --ti regexp: include tasks matching regexp'
    print '  --te regexp: exclude tasks matching regexp'
    
    print '  --ci regexp: include contexts matching regexp'
    print '  --ce regexp: exclude contexts matching regexp'
     
    print '  --tci regexp: include tasks with completion matching regexp'
    print '  --tce regexp: exclude tasks with completion matching regexp'
    
    print '  --tsi regexp: include tasks with start matching regexp'
    print '  --tse regexp: exclude tasks with start matching regexp'
    
    print '  --tdi regexp: include tasks with due matching regexp'
    print '  --tde regexp: exclude tasks with due matching regexp'
    
    print '  --tfi: include flagged tasks'
    print '  --tfe: exclude flagged tasks'
    
    print '  --tsc: sort tasks by completion'
    
    print '  -F: flatten project/task structure'
    print '  --prune: prune empty projects or folders'

if __name__ == "__main__":
    
    today = date.today ()
    time_fmt='%Y-%m-%d'
    opn=False
    project_mode=True
    file_name = None
    paul = False
        
    opts, args = getopt.optlist, args = getopt.getopt(sys.argv[1:], 'hFC?o:',
                                                      ['fi=','fe=',
                                                       'ci=','ce=',
                                                       'pi=','pe=',
                                                       'pci=','pce=',
                                                       'psi=','pse=',
                                                       'pdi=','pde=',
                                                       'pfi','pfe',
                                                       'ti=','te=',
                                                       'tci=','tce=',
                                                       'tsi=','tse=',
                                                       'tdi=','tde=',
                                                       'tfi','tfe',
                                                       'tsc',
                                                       'help',
                                                       'open',
                                                       'prune',
                                                       'paul'])
    for opt, arg in opts:
        if '--open' == opt:
            opn = True
        elif '--paul' == opt:
            paul = True
        elif '-C' == opt:
            project_mode = False
        elif '-o' == opt:
            file_name = arg;
        elif opt in ('-?', '-h', '--help'):
            print_help ()
            sys.exit()
    
    if file_name == None:
            print_help ()
            sys.exit()
    
    dot = file_name.index ('.')
    if dot == -1:
        print 'output file name must have suffix'
        sys.exit()
    
    fmt = file_name[dot+1:]
    
    root_projects_and_folders, root_contexts = build_model (find_database ())
    
    if project_mode:
        items = root_projects_and_folders
    else:
        items = root_contexts
        
    for opt, arg in opts:
        
        # FOLDER
        if '--fi' == opt:
            visitor = FolderNameFilterVisitor (arg, include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--fe' == opt:
            visitor = FolderNameFilterVisitor (arg, include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        
        # PROJECT
        elif '--pi' == opt:
            visitor = ProjectNameFilterVisitor (arg, include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--pe' == opt:
            visitor = ProjectNameFilterVisitor (arg, include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--psi' == opt:
            visitor = ProjectStartFilterVisitor (arg, include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--pse' == opt:
            visitor = ProjectStartFilterVisitor (arg, include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--pdi' == opt:
            visitor = ProjectDueFilterVisitor (arg, include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--psc' == opt:
            visitor = ProjectDueFilterVisitor (arg, include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--pci' == opt:
            visitor = ProjectCompletionFilterVisitor (arg, include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--pce' == opt:
            visitor = ProjectCompletionFilterVisitor (arg, include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--pfi' == opt:
            visitor = ProjectFlaggedFilterVisitor (include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--pfe' == opt:
            visitor = ProjectFlaggedFilterVisitor (include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
            
        # CONTEXT
        elif '--ci' == opt:
            visitor = ContextNameFilterVisitor (arg, include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--ce' == opt:
            visitor = ContextNameFilterVisitor (arg, include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        
        # TASK
        elif '--ti' == opt:
            visitor = TaskNameFilterVisitor (arg, include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--te' == opt:
            visitor = TaskNameFilterVisitor (arg, include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--tci' == opt:
            visitor = TaskCompletionFilterVisitor (arg, include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--tce' == opt:
            visitor = TaskCompletionFilterVisitor (arg, include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--tsi' == opt:
            visitor = TaskStartFilterVisitor (arg, include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--tse' == opt:
            visitor = TaskStartFilterVisitor (arg, include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--tdi' == opt:
            visitor = TaskDueFilterVisitor (arg, include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--tde' == opt:
            visitor = TaskDueFilterVisitor (arg, include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--tfi' == opt:
            visitor = TaskFlaggedFilterVisitor (include=True)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--tfe' == opt:
            visitor = TaskFlaggedFilterVisitor (include=False)
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '--tsc' == opt:
            visitor = TaskCompletionSortingVisitor ()
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        
        # MISC
        elif '--prune' == opt:
            visitor = PruningFilterVisitor ()
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, items)
        elif '-F' == opt:
            visitor = FlatteningVisitor ()
            print opt + '\t= ' + str (visitor)
            traverse_list (visitor, root_projects_and_folders)
            root_projects_and_folders = visitor.projects

    file_name_base = os.environ['HOME']+'/Desktop/'
    date_str = today.strftime (time_fmt)
    
    if fmt == 'txt' or fmt == 'text':
        out=codecs.open(file_name, 'w', 'utf-8')
        
        print_structure (PrintTextVisitor (out), root_projects_and_folders, root_contexts, project_mode)
        
    # MARKDOWN
    elif fmt == 'md' or fmt == 'markdown':
        out=codecs.open(file_name, 'w', 'utf-8')
        
        print_structure (PrintMarkdownVisitor (out), root_projects_and_folders, root_contexts, project_mode)
        
    # FOLDING TEXT
    elif fmt == 'ft' or fmt == 'foldingtext':
        out=codecs.open(file_name, 'w', 'utf-8')
        
        print_structure (PrintMarkdownVisitor (out), root_projects_and_folders, root_contexts, project_mode)
                
    # TASKPAPER            
    elif fmt == 'tp' or fmt == 'taskpaper':
        out=codecs.open(file_name, 'w', 'utf-8')
        visitor = None
        if paul:
            visitor = CustomPrintTaskpaperVisitor (out)
        else:
            visitor = PrintTaskpaperVisitor (out)
        print_structure (visitor, root_projects_and_folders, root_contexts, project_mode)
    
    # OPML
    elif fmt == 'opml':
        out=codecs.open(file_name, 'w', 'utf-8')
        print >>out, '<?xml version="1.0" encoding="UTF-8" standalone="no"?>'
        print >>out, '<opml version="1.0">'
        print >>out, '  <head>'
        print >>out, '    <title>OmniFocus</title>'
        print >>out, '  </head>'
        print >>out, '  <body>'
        
        print_structure (PrintOpmlVisitor (out, depth=1), root_projects_and_folders, root_contexts, project_mode)
        
        print >>out, '  </body>'
        print >>out, '</opml>'
    
    # Let's try JSON!
    
    # elif fmt =='json':
    #     out=codexs.open(file_name, 'w', 'utf-8')
    #     print >>out, ''
        
        
    # Statusboard HTML
    elif fmt =='html':
        out=codecs.open(file_name, 'w', 'utf-8')
        print >>out, '  <table id="projects">'
        
        print_structure (PrintHtmlVisitor (out, depth=1), root_projects_and_folders, root_contexts, project_mode)
        
        print >>out, '  </table>'
        
    # HTML
    # elif fmt == 'html' or fmt == 'htm':
    #     out=codecs.open(file_name, 'w', 'utf-8')
    #     print >>out, '<html>'
    #     print >>out, '  <head>'
    #     print >>out, '    <title>OmniFocus</title>'
    #     print >>out, '  </head>'
    #     print >>out, '  <body>'
    #     
    #     print_structure (PrintHtmlVisitor (out, depth=1), root_projects_and_folders, root_contexts, project_mode)
    #     
    #     print >>out, '  </body>'
    #     print >>out, '<html>'
    else:
        raise Exception ('unknown format ' + fmt)
    
    # Close the file and open it
    out.close()
    
    if opn:
        os.system("open '" + file_name + "'")