taskjuggler 0.0.10 → 0.0.11

data/lib/tj3client.rb

@@ -11,447 +11,7 @@
 # published by the Free Software Foundation.
 #
 
-require 'drb'
-require 'drb/acl'
-require 'Tj3AppBase'
-require 'LogFile'
+require 'taskjuggler/apps/Tj3Client'
 
-# Name of the application
-AppConfig.appName = 'tj3client'
-
-class TaskJuggler
-
-  # The Tj3Client class provides the primary interface to the TaskJuggler
-  # daemon. It exposes a rich commandline interface that supports key
-  # operations like add/removing a project, generating a report or checking a
-  # time or status sheet. All connections are made via DRb and tj3client
-  # requires a properly configured tj3d to work.
-  class Tj3Client < Tj3AppBase
-
-    def initialize
-      super
-
-      # For security reasons, this will probably not change. All DRb
-      # operations are limited to localhost only. The client and the sever
-      # must have access to the identical file system.
-      @host = '127.0.0.1'
-      # The default port. 'T' and 'J' in ASCII decimal
-      @port = 8474
-      # The file with the server URI in case port is 0.
-      @uriFile = File.join(Dir.getwd, '.tj3d.uri')
-      # This must must be changed for the communication to work.
-      @authKey = nil
-      # Determines whether report IDs are fix IDs or regular expressions that
-      # match a set of reports.
-      @regExpMode = false
-      # List of requested output formats for reports.
-      @formats = nil
-
-      @mandatoryArgs = '<command> [arg1 arg2 ...]'
-
-      # This list describes the supported command line commands and their
-      # parameter.
-      # :label : The command name
-      # :args : A list of parameters. If the first character is a '+' the
-      # parameter must be provided 1 or more times. If the first character is
-      # a '*' the parameter must be provided 0 or more times. Repeatable and
-      # optional paramters must follow the mandatory ones.
-      # :descr : A short description of the command used for the help text.
-      @commands = [
-        { :label => 'status',
-          :args  => [],
-          :descr => 'Display the status of the available projects' },
-        { :label => 'terminate',
-          :args  => [],
-          :descr => 'Terminate the TaskJuggler daemon' },
-        { :label => 'add',
-          :args  => [ 'tjp file', '*tji file'],
-          :descr => 'Add a new project or update and existing one' },
-        { :label => 'update',
-          :args => [],
-          :descr => 'Reload all projects that have modified files and '+
-                    'are not being reloaded already' },
-        { :label => 'remove',
-          :args  => [ '+project ID' ],
-          :descr => 'Remove the project with the specified ID from the ' +
-                    'daemon' },
-        { :label => 'report',
-          :args  => [ 'project ID', '+report ID', '!=', '*tji file'],
-          :descr => 'Generate the report with the provided ID for ' +
-                    'the project with the given ID'},
-        { :label => 'list-reports',
-          :args  => [ 'project ID', '!report ID' ],
-          :descr => 'List all available reports of the project or those ' +
-                    'that match the provided report ID' },
-        { :label => 'check-ts',
-          :args  => [ 'project ID', 'time sheet' ],
-          :descr => 'Check the provided time sheet for correctness ' +
-                    'against the project with the given ID'},
-        { :label => 'check-ss',
-          :args  => [ 'project ID', 'status sheet' ],
-          :descr => 'Check the provided status sheet for correctness ' +
-                    'against the project with the given ID'}
-      ]
-    end
-
-    def processArguments(argv)
-      super do
-        @opts.banner += <<'EOT'
-The TaskJuggler client is used to send commands and data to the TaskJuggler
-daemon. The communication is done via TCP/IP.
-
-The following commands are supported:
-
-EOT
-
-        # Convert the command list into a help text.
-        @commands.each do |cmd|
-          tail = ''
-          args = cmd[:args].dup
-          args.map! do |c|
-            if c[0] == '*'
-              "[<#{c[1..-1]}> ...]"
-            elsif c[0] == '+'
-              "<#{c[1..-1]}> [<#{c[1..-1]}> ...]"
-            elsif c[0] == '!'
-              tail += ']'
-              "[#{c[1..-1]} "
-            else
-              "<#{c}>"
-            end
-          end
-          args = args.join(' ')
-          @opts.banner += "     #{cmd[:label] + ' ' + args + tail}" +
-                          "\n\n#{' ' * 10 + format(cmd[:descr], 10)}\n"
-        end
-        @opts.on('-p', '--port <NUMBER>', Integer,
-                 format('Use the specified TCP/IP port')) do |arg|
-           @port = arg
-        end
-        @opts.on('--urifile', String,
-                 format('If the port is 0, use this file to get the URI ' +
-                        'of the server.')) do |arg|
-          @uriFile = arg
-        end
-        @opts.on('-r', '--regexp',
-                 format('The report IDs are not fixed but regular expressions ' +
-                        'that match a set of reports')) do |arg|
-          @regExpMode = true
-        end
-        @opts.on('--format [FORMAT]', [ :csv, :html, :niku, :tjp ],
-                 format('Request the report to be generated in the specified' +
-                        'format. Use multiple options to request multiple ' +
-                        'formats. Supported formats are csv, html, niku and ' +
-                        'tjp. By default, the formats specified in the report ' +
-                        'definition are used.')) do |arg|
-          @formats = [] unless @formats
-          @formats << arg
-        end
-      end
-    end
-
-    def main
-      args = super
-      # Run a first check of the non-option command line arguments.
-      checkCommand(args)
-      # Read some configuration variables. Except for the authKey, they are
-      # all optional.
-      @rc.configure(self, 'global')
-
-      connectDaemon
-      retVal = executeCommand(args[0], args[1..-1])
-      disconnectDaemon
-
-      retVal
-    end
-
-    private
-
-    def checkCommand(args)
-      if args.empty?
-        errorMessage = 'You must specify a command!'
-      else
-        errorMessage = "Unknown command #{args[0]}"
-        @commands.each do |cmd|
-          # The first value of args is the command name.
-          if cmd[:label] == args[0]
-            # Find out how many arguments we need to have and if that's a
-            # lower limit or a fixed value.
-            minArgs = 0
-            varArgs = false
-            cmd[:args].each do |arg|
-              # Arguments starting with '+' must have 1 or more showings.
-              # Arguments starting with '*' may show up 0 or more times.
-              minArgs += 1 unless '!*'.include?(arg[0])
-              varArgs = true if '!*+'.include?(arg[0])
-            end
-            return true if args.length - 1 >= minArgs
-            errorMessage = "Command #{args[0]} must have " +
-                           "#{varArgs ? 'at least ' : ''}#{minArgs} " +
-                           'arguments'
-          end
-        end
-      end
-
-      error(errorMessage)
-    end
-
-    def connectDaemon
-      unless @authKey
-        $stderr.puts <<'EOT'
-You must set an authentication key in the configuration file. Create a file
-named .taskjugglerrc or taskjuggler.rc that contains at least the following
-lines. Replace 'your_secret_key' with some random character sequence.
-
-_global:
-  authKey: your_secret_key
-EOT
-      end
-
-      uri = "druby://#{@host}:#{@port}"
-      if @port == 0
-        # If the @port is configured to 0, we need to read the URI to connect
-        # to the server from the .tj3d.uri file that has been generated by the
-        # server.
-        begin
-          uri = File.read(@uriFile).chomp
-        rescue
-          error('The server port is configured to be 0, but no ' +
-                ".tj3d.uri file can be found: #{$!}")
-        end
-      end
-
-      # We try to play it safe here. The client also starts a DRb server, so
-      # we need to make sure it's constricted to localhost only. We require
-      # the DRb server for the standard IO redirection to work.
-      $SAFE = 1
-      DRb.install_acl(ACL.new(%w[ deny all
-                                  allow 127.0.0.1 ]))
-      DRb.start_service('druby://127.0.0.1:0')
-
-      begin
-        # Get the ProjectBroker object from the tj3d.
-        @broker = DRbObject.new(nil, uri)
-        # Client and server should always come from the same Gem. Since we
-        # restict communication to localhost, that's probably not a problem.
-        if (check = @broker.apiVersion(@authKey, 1)) < 0
-          error('This client is too old for the server. Please ' +
-                'upgrade to a more recent version of the software.')
-        elsif check == 0
-          error('Authentication failed. Please check your authentication ' +
-                'key to match the server key.')
-        end
-      rescue
-        error("TaskJuggler server on host '#{@host}' port " +
-              "#{@port} is not responding")
-      end
-    end
-
-    def disconnectDaemon
-      @broker = nil
-
-      DRb.stop_service
-    end
-
-    def executeCommand(command, args)
-      case command
-      when 'status'
-        $stdout.puts callDaemon(:status, [])
-      when 'terminate'
-        callDaemon(:stop, [])
-        info('Daemon terminated')
-      when 'add'
-        res = callDaemon(:addProject, [ Dir.getwd, args,
-                                        $stdout, $stderr, $stdin, @silent ])
-        info("Project(s) #{args.join(', ')} added")
-        return res ? 0 : 1
-      when 'remove'
-        args.each do |arg|
-          unless callDaemon(:removeProject, arg)
-            error("Project '#{arg}' not found in list")
-          end
-        end
-        info('Project removed')
-      when 'update'
-        callDaemon(:update, [])
-        info('Reload requested')
-      when 'report'
-        # The first value of args is the project ID. The following values
-        # could be either report IDs or TJI file # names ('.' or '*.tji').
-        projectId = args.shift
-        # Ask the ProjectServer to launch a new ReportServer process and
-        # provide a DRbObject reference to it.
-        connectToReportServer(projectId)
-
-        reportIds, tjiFiles = splitIdsAndFiles(args)
-        if reportIds.empty?
-          disconnectReportServer
-          error('You must provide at least one report ID')
-        end
-        # Send the provided .tji files to the ReportServer.
-        failed = !addFiles(tjiFiles)
-        # Ask the ReportServer to generate the reports with the provided IDs.
-        unless failed
-          reportIds.each do |reportId|
-            unless @reportServer.generateReport(@rs_authKey, reportId,
-                                                @regExpMode, @formats, nil)
-              failed = true
-              break
-            end
-          end
-        end
-        # Terminate the ReportServer
-        disconnectReportServer
-        return failed ? 1 : 0
-      when 'list-reports'
-        # The first value of args is the project ID. The following values
-        # could be either report IDs or TJI file # names ('.' or '*.tji').
-        projectId = args.shift
-        # Ask the ProjectServer to launch a new ReportServer process and
-        # provide a DRbObject reference to it.
-        connectToReportServer(projectId)
-
-        reportIds, tjiFiles = splitIdsAndFiles(args)
-        if reportIds.empty?
-          # If the user did not provide a report ID we generate a full list.
-          reportIds = [ '.*' ]
-          @regExpMode = true
-        end
-        # Send the provided .tji files to the ReportServer.
-        failed = !addFiles(tjiFiles)
-        # Ask the ReportServer to generate the reports with the provided IDs.
-        unless failed
-          reportIds.each do |reportId|
-            unless @reportServer.listReports(@rs_authKey, reportId, @regExpMode)
-              failed = true
-              break
-            end
-          end
-        end
-        # Terminate the ReportServer
-        disconnectReportServer
-        return failed ? 1 : 0
-      when 'check-ts'
-        connectToReportServer(args[0])
-        begin
-          res = @reportServer.checkTimeSheet(@rs_authKey, args[1])
-        rescue
-          error("Time sheet check failed: #{$!}")
-        end
-        disconnectReportServer
-        return res ? 0 : 1
-      when 'check-ss'
-        connectToReportServer(args[0])
-        begin
-          res = @reportServer.checkStatusSheet(@rs_authKey, args[1])
-        rescue
-          error("Status sheet check failed: #{$!}")
-        end
-        disconnectReportServer
-        return res ? 0 : 1
-      else
-        raise "Unknown command #{command}"
-      end
-      0
-    end
-
-    def connectToReportServer(projectId)
-      @ps_uri, @ps_authKey = callDaemon(:getProject, projectId)
-      if @ps_uri.nil?
-        error("No project with ID #{projectId} loaded")
-      end
-      begin
-        @projectServer = DRbObject.new(nil, @ps_uri)
-        @rs_uri, @rs_authKey = @projectServer.getReportServer(@ps_authKey)
-        @reportServer = DRbObject.new(nil, @rs_uri)
-      rescue
-        error("Cannot get report server")
-      end
-      begin
-        @reportServer.connect(@rs_authKey, $stdout, $stderr, $stdin, @silent)
-      rescue
-        error("Can't connect IO: #{$!}")
-      end
-    end
-
-    def disconnectReportServer
-      begin
-        @reportServer.disconnect(@rs_authKey)
-      rescue
-        error("Can't disconnect IO: #{$!}")
-      end
-      begin
-        @reportServer.terminate(@rs_authKey)
-      rescue
-        error("Report server termination failed: #{$!}")
-      end
-      @reportServer = nil
-      @rs_uri = nil
-      @rs_authKey = nil
-      @projectServer = nil
-      @ps_uri = nil
-      @ps_authKey = nil
-    end
-
-    # Call the TaskJuggler daemon (ProjectBroker) and execute the provided
-    # command with the provided arguments.
-    def callDaemon(command, args)
-      begin
-        return @broker.command(@authKey, command, args)
-      rescue
-        error("Call to TaskJuggler server on host '#{@host}' " +
-              "port #{@port} failed: #{$!}")
-      end
-    end
-
-    # Sort the remaining arguments into a report ID and a TJI file list.
-    # If .tji files are present, they must be separated from the report ID
-    # list by a '='.
-    def splitIdsAndFiles(args)
-      reportIds = []
-      tjiFiles = []
-      addToReports = true
-      args.each do |arg|
-        if arg == '='
-          # Switch to tji file list.
-          addToReports = false
-        elsif addToReports
-          reportIds << arg
-        else
-          tjiFiles << arg
-        end
-      end
-
-      [ reportIds, tjiFiles ]
-    end
-
-    # Transfer the _tjiFiles_ to the _reportServer_.
-    def addFiles(tjiFiles)
-      tjiFiles.each do |file|
-        begin
-          unless @reportServer.addFile(@rs_authKey, file)
-            return false
-          end
-        rescue
-          error("Cannot add file #{file} to ReportServer")
-        end
-      end
-      true
-    end
-
-    def info(message)
-      return if @silent
-      $stdout.puts "#{message}"
-    end
-
-    def error(message)
-      $stderr.puts "ERROR: #{message}"
-      exit 1
-    end
-
-  end
-
-end
-
-exit TaskJuggler::Tj3Client.new.main()
+exit TaskJuggler::Tj3Client.new.main(ARGV)
 

data/lib/tj3d.rb

@@ -11,139 +11,7 @@
 # published by the Free Software Foundation.
 #
 
-require 'drb'
-require 'Tj3AppBase'
-require 'LogFile'
-require 'daemon/ProjectBroker'
-
-# Name of the application
-AppConfig.appName = 'tj3d'
-
-class TaskJuggler
-
-  class Tj3Daemon < Tj3AppBase
-
-    def initialize
-      super
-      @mandatoryArgs = '[<tjp file> [<tji file> ...] ...]'
-
-      @log = LogFile.instance
-      @log.logFile = File.join(Dir.getwd, "/#{AppConfig.appName}.log")
-      @log.appName = AppConfig.appName
-      @daemonize = true
-      @uriFile = File.join(Dir.getwd, '.tj3d.uri')
-      @port = nil
-      @webServer = false
-      @webServerPort = nil
-    end
-
-    def processArguments(argv)
-      super do
-        @opts.banner += <<'EOT'
-The TaskJuggler daemon can be used to quickly generate reports for a number
-of scheduled projects that are resident in memory. Once the daemon has been
-started tj3client can be used to control it.
-EOT
-        @opts.on('-d', '--dont-daemonize',
-                 format("Don't put program into daemon mode. Keep it " +
-                        'connected to the terminal and show debug output.')) do
-          @daemonize = false
-        end
-        @opts.on('-p', '--port <NUMBER>', Integer,
-                 format('Use the specified TCP/IP port to serve tj3client ' +
-                        'requests (Default: 8474).')) do |arg|
-          @port = arg
-        end
-        @opts.on('--urifile', String,
-                 format('If the port is 0, use this file to store the URI ' +
-                        'of the server.')) do |arg|
-          @uriFile = arg
-        end
-        @opts.on('-w', '--webserver',
-                 format('Start a web server that serves the reports of ' +
-                        'the loaded projects.')) do
-          @webServer = true
-        end
-        @opts.on('--webserver-port <NUMBER>', Integer,
-                 format('Use the specified TCP/IP port to serve web browser ' +
-                        'requests (Default: 8080).')) do |arg|
-          @webServerPort = arg
-        end
-      end
-    end
-
-    def main
-      files = super
-      broker = ProjectBroker.new
-      @rc.configure(self, 'global')
-      @rc.configure(@log, 'global.log')
-      @rc.configure(broker, 'global')
-      @rc.configure(broker, 'daemon')
-
-      # Set some config variables if corresponding data was provided via the
-      # command line.
-      broker.port = @port if @port
-      broker.uriFile = @uriFile.untaint
-      broker.enableWebServer = @webServer
-      broker.webServerPort = @webServerPort if @webServerPort
-      broker.projectFiles = sortInputFiles(files) unless files.empty?
-      broker.daemonize = @daemonize
-      # Create log files for standard IO for each child process if the daemon
-      # is not disconnected from the terminal.
-      broker.logStdIO = !@daemonize
-
-      broker.start
-    end
-
-    def error(message)
-      $stderr.puts "ERROR: #{message}"
-      exit 1
-    end
-
-    private
-
-    # Sort the provided input files into groups of projects. Each *.tjp file
-    # starts a new project. A *.tjp file may be followed by any number of
-    # *.tji files. The result is an Array of projects. Each consists of an
-    # Array like this: [ <working directory>, <tjp file> (, <tji file> ...) ].
-    def sortInputFiles(files)
-      projects = []
-      project = nil
-      files.each do |file|
-        if file[-4..-1] == '.tjp'
-          # The project master file determines the working directory. If it's
-          # an absolute file name, that directory will become the working
-          # directory. If it's a relative file name, the current working
-          # directory will be kept.
-          if file[0] == '/'
-            # Absolute file name
-            workingDir = File.dirname(file)
-            fileName = File.basename(file)
-          else
-            # Relative file name
-            workingDir = Dir.getwd
-            fileName = file
-          end
-          project = [ workingDir, fileName ]
-          projects << project
-        elsif file[-4..-1] == '.tji'
-          # .tji files are optional. But if they are specified, they must
-          # always follow the master file in the list.
-          if project.nil?
-            error("You must specify a '.tjp' file before the '.tji' files")
-          end
-          project << file
-        else
-          error("Project files must have a '.tjp' or '.tji' extension")
-        end
-      end
-
-      projects
-    end
-
-  end
-
-end
+require 'taskjuggler/apps/Tj3Daemon'
 
 exit TaskJuggler::Tj3Daemon.new.main()