launch_manager.h

Go to the documentation of this file.

 
// current bad issues:
//
// this class does not really provide a notion of the process name AND process id as being
// a pair one can operate on.  mostly it assumes a bunch of singletons or that it's okay
// to whack all of them.
// that could be fixed by making the procname+procid pair into a unit in all functions,
// and make kill_all be a specialization of that.
 
 
#ifndef LAUNCH_MANAGER_CLASS
#define LAUNCH_MANAGER_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : launch_manager
*  Author : Chris Koeritz
*                                                                             *
*******************************************************************************
* Copyright (c) 2000-$now By Author.  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 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/astring.h>
#include <basis/mutex.h>
#include <basis/outcome.h>
#include <basis/contracts.h>
#include <processes/configured_applications.h>
#include <processes/process_entry.h>
#include <processes/process_control.h>
#include <structures/set.h>
#include <timely/time_stamp.h>
 
namespace application {
 
class graceful_array;
class launch_manager_thread;
 
 
class launch_manager : public virtual basis::root_object
{
public:
  launch_manager(processes::configured_applications &config);
 
  virtual ~launch_manager();
 
  DEFINE_CLASS_NAME("launch_manager");
 
  enum outcomes {
    OKAY = basis::common::OKAY,
    EXISTING = basis::common::EXISTING,
    ACCESS_DENIED = basis::common::ACCESS_DENIED,
 
    DEFINE_API_OUTCOME(FILE_NOT_FOUND, -53, "The file specified for the "
        "application doesn't exist, as far as we can tell"),
    DEFINE_API_OUTCOME(NO_PRODUCT, -54, "The product specified does not exist"),
    DEFINE_API_OUTCOME(NO_APPLICATION, -55, "The application is not listed for "
        "the product"),
    DEFINE_API_OUTCOME(NOT_RUNNING, -56, "The program is not currently active, "
        "according to the OS process list"),
    DEFINE_API_OUTCOME(BAD_PROGRAM, -57, "The file existed but doesn't appear "
        "to be a valid program image"),
    DEFINE_API_OUTCOME(NO_ANCHOR, -58, "This occurs when the graceful shutdown "
        "process cannot find the special anchor window that implements the "
        "client side of a graceful shutdown"),
    DEFINE_API_OUTCOME(LAUNCH_FAILED, -59, "The program existed and seemed "
        "valid but its launch failed for some reason"),
    DEFINE_API_OUTCOME(FROZEN, -60, "The application is broken somehow; the "
        "system reports it as non-responsive"),
    // note that these values are reversed, since the ordering is negative.
    FIRST_OUTCOME = FROZEN,  // hold onto start of range.
    LAST_OUTCOME = FILE_NOT_FOUND // hold onto end of range.
  };
 
  static const char *outcome_name(const basis::outcome &to_name);
 
  basis::outcome launch_now(const basis::astring &product, const basis::astring &app_name,
          const basis::astring &parameters);
 
  basis::outcome launch_at_startup(const basis::astring &product, const basis::astring &app_name,
          const basis::astring &parameters, int one_shot);
 
  basis::outcome remove_from_startup(const basis::astring &product, const basis::astring &app_name);
 
  basis::outcome query_application(const basis::astring &product, const basis::astring &app_name);
 
  basis::outcome zap_process(const basis::astring &product, const basis::astring &app_name,
          bool graceful);
 
  void add_gag_exclusion(const basis::astring &exclusion);
 
  void add_tracking_exclusion(const basis::astring &exclusion);
 
  basis::outcome shut_down_launching_services(const basis::astring &secret_word);
 
  basis::outcome reenable_launching_services(const basis::astring &secret_word);
 
  bool services_disabled() const { return _stop_launching; }
 
  void push_timed_activities(processes::process_entry_array &processes);
 
  void stop_everything();
 
private:
  processes::configured_applications &_configs;  
  bool _started_initial_apps;  
  launch_manager_thread *_checker;  
  basis::mutex *_config_lock;  
  graceful_array *_going_down;  
  basis::mutex *_zombie_lock;  
  graceful_array *_our_kids;  
  basis::mutex *_scamp_lock;  
  bool _stop_launching;  
  timely::time_stamp *_startup_time;
 
  processes::process_control *_procs;  
  structures::string_set *_gag_exclusions;  
  structures::string_set *_tracking_exclusions;  
 
  bool get_processes(processes::process_entry_array &processes);
 
  bool find_process(const basis::astring &app_name, structures::int_set &pids);
 
  basis::outcome start_graceful_close(const basis::astring &product, const basis::astring &app_name);
 
  void launch_startup_apps();
 
  void stop_all_kids();
};
 
} //namespace.
 
#endif