#!/usr/bin/python2.6
#
# Copyright (c) 2012
#  Adam Tauno Williams <awilliam@whitemice.org>
#
# 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 coils.core  import *
import getopt, sys, os

def usage():
    print """
    --help      Display this helpful messages
    --scan      Scan for remnants that could be removed.
    --execute   Remove workflow process remnants.
    """
    return

def main(argv):

    # Process command line arguements
    if not argv:
        usage( )
        sys.exit( 2 )
    try:
        opts, args = getopt.getopt( argv,
                                    "hes",
                                    [ "help", "execute", "scan" ] )
    except getopt.GetoptError, e:
        print( e )
        usage( )
        sys.exit( 2 )

    enable_scan = False
    enable_fix = False
    for opt, arg in opts:
        if opt in ( "-h", "--help" ):
            usage( )
            sys.exit( 0 )
        elif opt in ( "-e", "--execute" ):
            enable_fix = True
        elif opt in ( "-s", "--scan" ):
            enable_scan = True

    # Initialize COILs
    initialize_COILS( { 'log_file': '{0}/coils.log'.format( os.getenv( 'HOME' ) ) } )
    ctx = AdministrativeContext( )

    if not enable_scan:
        print( 'Scan for remnants not requested, see the --scan option.' )
        sys.exit( 0 )

    pids = { }
    for filename in BLOBManager.List( 'wf/p' ):
        try:
            pid = long( filename.split( '.' )[0] )
        except:
            pass
        else:
            if pid not in pids:
                pids[ pid ] = [ filename ]
            else:
                pids[ pid ].append( filename )
    bad_pids = { }
    counter = 0
    for pid in pids:
        process = ctx.run_command( 'process::get', id=pid)
        if not process:
            counter += len( pids[ pid ] )
            bad_pids[ pid ] = pids[ pid ]
    print( 'Found {0} remnants of {1} PIDs'.format( counter, len( bad_pids ) ) )
    
    if not counter:
        print( 'No workflow process remnants exist to be removed, tool complete.' )
        sys.exit( 0 )
    
    if not enable_fix:
        print( 'Removal of remnants not requested, see the --execute option.' )
        sys.exit( 0 )    
    
    for pid, filenames in bad_pids.items():
        print pid, filenames
        for filename in filenames:
            print filename
            BLOBManager.Delete( 'wf/p/{0}'.format( filename ) )

    print( 'Tool complete.' )

    sys.exit( 0 )

if __name__ == '__main__':

    main( sys.argv[1:] )
