zimarchivist.py

#!/usr/bin/env python

#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/>
#
# Author: Francois Boulogne <fboulogne at sciunto dot org>, 2012

#System...
import sys
import os
import glob
import getopt

#Regex
import re

import logging


#our lib...
from ZimArchivist import zimnotes
from ZimArchivist import utils
from ZimArchivist import timechecker
from ZimArchivist import archive


#############
# Archives
#############



#############
# Main
#############

def usage():
    """ Print usage... """
    usage = """
    zimarchivist --cache -d ~/Notes

    Actions:
        --cache: make a cache
        Arg: 
            -d: Zim notes directory
        Option:
            -f: Zim file path (Otherwise, the notebook is processed)


        --clean: clean the cache by removing unnecessary archives
        Arg: 
            -d: Zim notes directory

     Other options:
        --no-timecheck: Do not check if zim file has been modified
                        since the last time.
    """

    print(usage)


if __name__ == '__main__':
    try:
        os.makedirs(os.path.expanduser('~/.zimarchivist'), exist_ok=True)
    except:
        print('Impossible to create ~/.zimarchivist/, Exiting...')
        sys.exit(2)

    utils.create_pidfile()

    log_filename = os.path.expanduser('~/.zimarchivist/zimarchivist.log')
    logging.basicConfig(filename=log_filename, filemode='w', level=logging.DEBUG)

    
    zim_root = None
    zim_archive_path = None
    zim_file_path = None
    
    try:
        opts, args = getopt.getopt(sys.argv[1:],"hd:f:", ['help', 'clean', 'cache'])
    except getopt.GetoptError:
        logging.critical('Wrong option')
        usage() 
        sys.exit(2)

        
    action_make_archive = False
    action_clean_archive = False
    checktime = True
        
    for opt, arg in opts:   
        if opt in ('-h', '--help'):
            logging.debug("Option -h")
            usage()
            sys.exit(0)
        elif opt in '--log':
            pass
            #TODO
            #logging.basicConfig(filename=log_filename, filemode='w', level=logging.DEBUG)
        elif opt in '--clean':
            logging.debug("Option --clean")
            action_clean_archive = True
        elif opt in '--cache':
            logging.debug("Option --cache")
            action_make_archive = True
        elif opt in '--no-timecheck':
            logging.debug("Option --no-timecheck")
            checktime = False
        elif opt in '-d':
            logging.debug("Option -d: " + str(arg))
            zim_root = os.path.realpath(arg) 
        elif opt in '-f':
            logging.debug("Option -f: " + str(arg))
            zim_file_path = os.path.realpath(arg) 

    if action_clean_archive or action_make_archive:
        #Check if we know paths...         
        if zim_root == None:
            logging.critical('Missing Notebook filepath. Exiting')
            usage()
            sys.exit(2)
        zim_archive_path = os.path.join(zim_root, '.Archive')
    else:
        usage()
        sys.exit(2)

    if action_make_archive:
        #Create the .Archive file
        if not (os.path.isdir(zim_archive_path)):
            try:
                os.mkdir(zim_archive_path)
            except OSError:
                logging.critical('could not make ', zim_archive_path)
                sys.exit(1)
            except IOError:
                logging.critical('could not make ', zim_archive_path)
                sys.exit(1)
        if zim_file_path == None: 
            #All file should be processed
            zim_files = zimnotes.get_zim_files(zim_root)
    
            logging.info('Processing zim files')
            for zim_file in zim_files:
                zim_file_relativepath = zim_file.split(zim_root + '/')[1]
                if timechecker.get_file_modif_status(zim_root, zim_file_relativepath) and checktime:
                    zimnotes.process_zim_file(zim_file, zim_archive_path)
                    timechecker.set_time(zim_file_relativepath)
                elif not checktime: 
                    logging.debug('Not modified since the last check: ' + str(zim_file_path))
                    zimnotes.process_zim_file(zim_file_path, zim_archive_path)
                    timechecker.set_time(zim_file_relativepath)
        else:
            #Only one file
            logging.info('Processing zim file: ' + str(zim_file_path))
            zim_file_relativepath = zim_file_path.split(zim_root + '/')[1]
            if timechecker.get_file_modif_status(zim_root, zim_file_relativepath) and checktime:
                zimnotes.process_zim_file(zim_file_path, zim_archive_path)
                timechecker.set_time(zim_file_relativepath)
            elif not checktime:
                logging.debug('Not modified since the last check: ' + str(zim_file_path))
                zimnotes.process_zim_file(zim_file_path, zim_archive_path)
                timechecker.set_time(zim_file_relativepath)



    if action_clean_archive:
        logging.info('Cache cleaning')
        zim_files = zimnotes.get_zim_files(zim_root)
        archive.clean_archive(zim_files, zim_archive_path)


    utils.release_pidfile()