Class: TaskJuggler::ProjectBroker

Inherits:
Daemon show all
Includes:
MessageHandler
Defined in:
lib/taskjuggler/daemon/ProjectBroker.rb

Overview

The ProjectBroker is the central object of the TaskJuggler daemon. It can manage multiple scheduled projects that it keeps in separate sub processes. Requests to a specific project will be redirected to the specific ProjectServer process. Projects can be added or removed. Adding an already existing one (identified by project ID) will replace the old one as soon as the new one has been scheduled successfully.

The daemon uses DRb to communicate with the client and it’s sub processes. The communication is restricted to localhost. All remote commands require an authentication key.

Currently only tj3client can be used to communicate with the TaskJuggler daemon.

Instance Attribute Summary collapse

Attributes inherited from Daemon

#daemonize, #pidFile

Instance Method Summary collapse

Methods included from MessageHandler

#critical, #debug, #error, #fatal, #info, #warning

Constructor Details

#initialize ⇒ ProjectBroker

Returns a new instance of ProjectBroker.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 44

def initialize
  super
  # We don't have a default key. The user must provice a key in the config
  # file. Otherwise the daemon will not start.
  @authKey = nil
  # The default TCP/IP port. ASCII code decimals for 'T' and 'J'.
  @port = 8474
  # The name of the URI file.
  @uriFile = nil
  # A list of loaded projects as Array of ProjectRecord objects.
  @projects = []
  # We operate with multiple threads so we need a Monitor to synchronize
  # the access to the list.
  @projects.extend(MonitorMixin)

  # A list of the initial projects. Array with Array of files names.
  @projectFiles = []

  # This Queue is used to load new projects. The DRb thread pushes load
  # requests that the housekeeping thread will then perform.
  @projectsToLoad = Queue.new

  # Set this flag to true to have standard IO logged into files. There
  # will be seperate set of files for each process.
  @logStdIO = !@daemonize

  # This flag will be set to true to terminate the daemon.
  @terminate = false
end

Instance Attribute Details

#authKey ⇒ Object

Returns the value of attribute authKey.



42
43
44
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 42

def authKey
  @authKey
end

#logStdIO ⇒ Object

Returns the value of attribute logStdIO.



42
43
44
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 42

def logStdIO
  @logStdIO
end

#port ⇒ Object

Returns the value of attribute port.



42
43
44
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 42

def port
  @port
end

#projectFiles ⇒ Object

Returns the value of attribute projectFiles.



42
43
44
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 42

def projectFiles
  @projectFiles
end

#uriFile ⇒ Object

Returns the value of attribute uriFile.



42
43
44
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 42

def uriFile
  @uriFile
end

Instance Method Details

#addProject(cwd, args, stdOut, stdErr, stdIn, silent) ⇒ Object

Adding a new project or replacing an existing one. The command waits until the project has been loaded or the load has failed.



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 196

def addProject(cwd, args, stdOut, stdErr, stdIn, silent)
  # We need some tag to identify the ProjectRecord that this project was
  # associated to. Just use a large enough random number.
  tag = rand(9999999999999)

  debug('', "Pushing #{tag} to load Queue")
  @projectsToLoad.push(tag)

  # Now we have to wait until the project shows up in the @projects
  # list. We use our tag to identify the right entry.
  pr = nil
  while pr.nil?
    @projects.synchronize do
      @projects.each do |p|
        if p.tag == tag
          pr = p
          break
        end
      end
    end
    # The wait in this loop should be pretty short and we don't want to
    # miss IO from the ProjectServer process.
    sleep 0.1 unless pr
  end

  debug('', "Found tag #{tag} in list of loaded projects with URI " +
        "#{pr.uri}")

  res = false

  # Open a DRb connection to the ProjectServer process
  begin
    projectServer = DRbObject.new(nil, pr.uri)
  rescue
    warning('pb_cannot_get_ps', "Can't get ProjectServer object: #{$!}")
    return false
  end
  begin
    # Hook up IO from requestor to the ProjectServer process.
    projectServer.connect(pr.authKey, stdOut, stdErr, stdIn, silent)
  rescue
    warning('pb_cannot_connect_io', "Can't connect IO: #{$!}")
    return false
  end

  # Ask the ProjectServer to load the files in _args_ into the
  # ProjectServer.
  begin
    res = projectServer.loadProject(pr.authKey, [ cwd, *args ])
  rescue
    warning('pb_load_failed', "Loading of project failed: #{$!}")
    return false
  end

  # Disconnect the IO from the ProjectServer and close the DRb connection.
  begin
    projectServer.disconnect(pr.authKey)
  rescue
    warning('pb_cannot_disconnect_io', "Can't disconnect IO: #{$!}")
    return false
  end

  res
end

#checkKey(authKey, command) ⇒ Object

All remote commands must provide the proper authentication key. Usually the client and the server get this secret key from the same configuration file.



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 143

def checkKey(authKey, command)
  if authKey == @authKey
    debug('', "Accepted authentication key for command '#{command}'")
  else
    warning('wrong_auth_key',
            "Rejected wrong authentication key '#{authKey}' " +
            "for command '#{command}'")
    return false
  end
  true
end

#getProject(projectId) ⇒ Object

Return the ProjectServer URI and authKey for the project with project ID projectId.



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 291

def getProject(projectId)
  # Find the project with the ID args[0].
  project = nil
  @projects.synchronize do
    @projects.each do |p|
      project = p if p.id == projectId && p.state == :ready
    end
  end

  if project.nil?
    debug('', "No project with ID #{projectId} found")
    return [ nil, nil ]
  end
  [ project.uri, project.authKey ]
end

#getProjectList ⇒ Object

Return a list of IDs of projects that are in state :ready.



321
322
323
324
325
326
327
328
329
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 321

def getProjectList
  list = []
  @projects.synchronize do
    @projects.each do |project|
      list << project.id if project.state == :ready
    end
  end
  list
end

#removeProject(indexOrId) ⇒ Object 



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 261

def removeProject(indexOrId)
  @projects.synchronize do
    # Find all projects with the IDs in indexOrId and mark them as
    # :obsolete.
    if /^[0-9]$/.match(indexOrId)
      index = indexOrId.to_i - 1
      if index >= 0 && index < @projects.length
        # If we have marked the project as obsolete, we return false to
        # indicate the double remove.
        return false if p.state == :obsolete
        @projects[index].state = :obsolete
        return true
      end
    else
      @projects.each do |p|
        if indexOrId == p.id
          # If we have marked the project as obsolete, we return false to
          # indicate the double remove.
          return false if p.state == :obsolete
          p.state = :obsolete
          return true
        end
      end
    end
  end
  false
end

#report(projectId, reportId) ⇒ Object 



331
332
333
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 331

def report(projectId, reportId)
  uri, key = getProject(projectId)
end

#start ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 74

def start
  # To ensure a certain level of security, the user must provide an
  # authentication key to authenticate the client to this server.
  unless @authKey
    error('pb_no_auth_key', <<'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

  # In daemon mode, we fork twice and only the 2nd child continues here.
  super()
  debug('', "Starting project broker")

  # Setup a DRb server to handle the incomming requests from the clients.
  brokerIface = ProjectBrokerIface.new(self)
  begin
    $SAFE = 1
    DRb.install_acl(ACL.new(%w[ deny all
                                allow 127.0.0.1 ]))
    @uri = DRb.start_service("druby://127.0.0.1:#{@port}", brokerIface).uri
    info('daemon_uri', "TaskJuggler daemon is listening on #{@uri}")
  rescue
    error('port_in_use', "Cannot listen on port #{@port}: #{$!}")
  end

  if @port == 0 && @uriFile
    # If the port is set to 0 (any port) we save the ProjectBroker URI in
    # the file .tj3d.uri. tj3client will look for it.
    begin
      File.open(@uriFile, 'w') { |f| f.write @uri }
    rescue
      error('cannot_write_uri', "Cannot write URI file #{@uriFile}: #{$!}")
    end
  end

  # If project files were specified on the command line, we add them here.
  i = 0
  @projectFiles.each do |project|
    @projectsToLoad.push(project)
  end

  # Start a Thread that waits for the @terminate flag to be set and does
  # some other work asynchronously.
  startHousekeeping

  debug('', 'Shutting down ProjectBroker DRb server')
  DRb.stop_service

  # If we have created a URI file, we need to delete it again.
  if @port == 0 && @uriFile
    begin
      File.delete(@uriFile)
    rescue
      error('cannot_delete_uri', "Cannot delete URI file .tj3d.uri: #{$!}")
    end
  end

  info('daemon_terminated', 'TaskJuggler daemon terminated')
end

#status ⇒ Object

Generate a table with information about the loaded projects.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 176

def status
  if @projects.empty?
    "No projects registered\n"
  else
    format = "  %3s | %-25s | %-14s | %s | %-20s\n"
    out = sprintf(format, 'No.', 'Project ID', 'Status', 'M',
                          'Loaded since')
    out += "  #{'-' * 4}+#{'-' * 27}+#{'-' * 16}+#{'-' * 3}+#{'-' * 20}\n"
    @projects.synchronize do
      i = 0
      @projects.each do |project|
        out += project.to_s(format, i += 1)
      end
    end
    out
  end
end

#stop ⇒ Object

This command will initiate the termination of the daemon.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 156

def stop
  debug('', 'Terminating on client request')

  # Shut down the web server if we've started one.
  if @webServer
    @webServer.stop
  end

  # Send termination signal to all ProjectServer instances
  @projects.synchronize do
    @projects.each { |p| p.terminateServer }
  end

  # Setting the @terminate flag to true will case the terminator Thread to
  # call DRb.stop_service
  @terminate = true
  super
end

#update ⇒ Object

Reload all projects that have modified files and are not already being reloaded.



309
310
311
312
313
314
315
316
317
318
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 309

def update
  @projects.synchronize do
    @projects.each do |project|
      if project.modified && !project.reloading
        project.reloading = true
        @projectsToLoad.push(project.files)
      end
    end
  end
end

#updateState(projectKey, filesOrId, state, modified) ⇒ Object

This is a callback from the ProjectServer process. It’s used to update the current state of the ProjectServer in the ProjectRecord list. projectKey is the authentication key for that project. It is used to idenfity the entry in the ProjectRecord list to be updated.



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/taskjuggler/daemon/ProjectBroker.rb', line 339

def updateState(projectKey, filesOrId, state, modified)
  result = false
  if filesOrId.is_a?(Array)
    files = filesOrId
    # Use the name of the master files for now.
    id = files[1]
  elsif filesOrId.is_a?(String)
    id = filesOrId
    files = nil
  else
    id = files = nil
  end

  @projects.synchronize do
    @projects.each do |project|
      # Don't accept updates for already obsolete entries.
      next if project.state == :obsolete

      debug('', "Updating state for #{id} to #{state}")
      # Only update the record that has the matching key
      if project.authKey == projectKey
        project.id = id if id
        # An Array of [ workingDir, tjpFile, ... other tji files ]
        project.files = files if files

        # If the state is being changed from something to :ready, this is
        # now the current project for the project ID.
        if state == :ready && project.state != :ready
          # Mark other project records with same project ID as obsolete
          @projects.each do |p|
            if p != project && p.id == id
              p.state = :obsolete
              debug('', "Marking entry with ID #{id} as obsolete")
            end
          end
          project.readySince = TjTime.new
        end

        # Failed ProjectServers are terminated automatically. We can't
        # reach them any more.
        project.uri = nil if state == :failed

        project.state = state
        project.modified = modified
        result = true
        break
      end
    end
  end

  result
end