SCPM interface  1.0
scpm.h
Go to the documentation of this file.
1 /*
2  * $Id: scpm.hh,v 1.5 2006/11/02 16:15:01 gleissner Exp $
3  *
4  *
5  * Project : SCPM (System Configuration Profile Management)
6  * Module : SCPM main engine
7  * File : scpm.hh
8  * Description : defines the SCPM interface
9  * Author : Joachim Gleissner <jg@suse.de>
10  *
11  * Copyright 2001 SuSE GmbH
12  * 2002-2004 SuSE Linux AG
13  *
14  * Released under the terms of the GNU General Public License
15  * (see file COPYRIGHT in project root directory).
16  *
17  */
18 #ifndef SCPM_H
19 #define SCPM_H
20 
21 #include <string>
22 #include <vector>
23 #include <scpm_types.h>
24 #include <scdb.h>
25 
26 class SCPM_helpers;
27 class Log;
28 
29 class SCPM
30 {
31 public:
32 
33  SCPM( int options=0, std::ostream &info_out=cout, std::ostream &hash_out=cout, std::string root="" );
34  ~SCPM();
35 
36  bool Enable( bool force=false );
37  bool Disable( );
38 
39  bool Active( std::string &profile );
40  bool List( std::vector<std::string> &profiles );
41 
42  bool Add( std::string profile, bool auto_switch=true );
43  bool Copy( std::string source_profile, std::string profile );
44  bool Create( std::string profile, std::string source_profile );
45  bool Delete( std::string profile );
46  bool Rename( std::string profile, std::string newprofile );
47  bool Reload( );
48  bool PrepareSwitch( std::string profile, switch_info_t &switch_info );
49  bool Switch( switch_info_t &switch_info );
50  bool Save( switch_info_t &switch_info );
51  bool Modify( std::string profile, std::string action );
52  bool Set( std::string command, std::string argument, std::string profile="" );
53  bool Get( std::string command, std::string &result, std::string profile="" );
54  bool Status( scpm_status_t &status );
55 
56  bool ShowChanges( std::ostream &output, std::string resource_type,
57  std::string resource_name, bool backup=false, string version="" );
58 
59  bool SetResourceSet( std::string set );
60  bool GetResourceSet( std::string &set );
61  bool ListResourceSets( std::vector<std::string> &predefined, std::vector<std::string> &individual );
62  bool CopyResourceSet( std::string set, std::string newset );
63  bool DeleteResourceSet( std::string set );
64 
65  bool ListResourceGroups( std::vector<resource_group_t> &groups );
66  bool GetResourceGroup( const std::string &name, std::vector<resource_entry_t> &group,
67  bool nouser=false );
68  bool GetResourceGroup( const std::string &name, std::vector<resource_entry_t> &group,
69  std::string &description, bool nouser=false );
70  bool SetResourceGroup( const std::string &name, const std::vector<resource_entry_t> &group,
71  const std::string &description );
72  bool DeleteResourceGroup( const std::string &group );
73  bool RenameResourceGroup( const std::string &group, const std::string &newgroup );
74  bool SetActiveResourceGroups( const std::vector<std::string> &groups );
75  bool GetActiveResourceGroups( std::vector<std::string> &groups );
76  bool ActivateResourceGroup( const std::string &group, bool auto_add=false );
77  bool DeactivateResourceGroup( const std::string &group, bool auto_remove=false );
78  bool ResetResourceGroup( const std::string &group );
79  bool ResetAllGroups( );
80 
81  bool RebuildDB( rebuild_mode_t mode=REBUILD_MODE_QUICK );
82 
83  bool SetConfigOption( const std::string &option, const std::string &value );
84  bool GetConfigOption( const std::string &option, std::string &value );
85 
86  // update and backup functions
87  bool Update( const std::string &scriptname, std::vector<pair<std::string, std::string> > resources );
88  bool UpdateResources( );
89  bool RestoreBackup( const std::vector<pair<string, string> > &resources, const std::vector<std::string> &versions, const std::string &profile );
90  bool RemoveBackup( const std::vector<pair<string, string> > &resources, const std::vector<std::string> &versions, const std::string &profile );
91  bool ListBackups( const std::string &profile, std::vector<backup_info_t> *reslist );
92  bool AddBackup( const std::vector<pair<string, string> > &resources, const std::string &profile);
93  bool Recover( bool rollback=false );
94 
95  bool Commit( );
96 
97 private:
98 
99  struct prepare_failed{};
100 
101  std::vector<resource_group_t> &GetGroupsByResource( const std::string &resname, const std::string &restype );
102  void Prepare( bool write_access=false );
103 
104  SCPM_helpers *sh;
105  Log *log;
106  bool db_open;
107  bool switch_prepared;
108  bool init_failed;
109 
110 };
111 
112 #endif
SCPM interface description - 2002,2003 SuSE Linux AG