LibPkg
unpack.h
Go to the documentation of this file.
1 // This file is part of LibPkg.
2 // Copyright � 2003-2005 Graham Shaw.
3 // Copyright � 2013-2014 Alan Buckley.
4 // Distribution and use are subject to the GNU Lesser General Public License,
5 // a copy of which may be found in the file !LibPkg.Copyright.
6 
7 #ifndef LIBPKG_UNPACK
8 #define LIBPKG_UNPACK
9 
10 #include <string>
11 #include <set>
12 #include <tr1/functional>
13 #include "string.h"
14 
15 #include "libpkg/auto_dir.h"
16 #include "libpkg/thread.h"
17 #include "libpkg/log.h"
18 
19 namespace pkg {
20 
21 using std::string;
22 
23 class pkgbase;
24 class zipfile;
25 class log;
26 class triggers;
27 class trigger_run;
28 class trigger;
29 
32  bool operator() (const std::string& a, const std::string& b) const {
33  return stricmp(a.c_str(), b.c_str()) < 0;
34  }
35 };
36 
38 class unpack:
39  public thread
40 {
41 public:
43  typedef unsigned long long size_type;
44 
46  static const size_type npos=static_cast<size_type>(-1);
47 
50  {
111  state_fail
112  };
113 private:
115  pkgbase& _pb;
116 
118  state_type _state;
119 
122  auto_dir _ad;
123 
125  zipfile* _zf;
126 
128  string _pkgname;
129 
131  size_type _files_done;
132 
134  size_type _files_total;
135 
137  size_type _bytes_done;
138 
140  size_type _bytes_total;
141 
143  size_type _files_total_unpack;
144 
146  size_type _files_total_remove;
147 
149  size_type _bytes_total_unpack;
150 
153  string _message;
154 
157  std::set<string> _packages_to_unpack;
158 
161  std::set<string> _packages_pre_unpacked;
162 
165  std::set<string> _packages_being_unpacked;
166 
169  std::set<string> _packages_unpacked;
170 
173  std::set<string> _packages_to_remove;
174 
177  std::set<string> _packages_being_removed;
178 
181  std::set<string> _packages_removed;
182 
185  std::set<string> _files_to_unpack;
186 
189  std::set<string> _files_being_unpacked;
190 
193  std::set<string> _files_unpacked;
194 
197  std::set<string> _empty_dirs_to_create;
198 
200  std::set<string> _dirs_being_created;
201 
204  std::set<string, case_insensitive_cmp> _files_to_remove;
205 
208  std::set<string, case_insensitive_cmp> _dirs_to_remove;
209 
212  std::set<string> _files_being_removed;
213 
216  std::set<string> _files_removed;
217 
220  std::set<string> _empty_dirs_to_check;
222  std::set<string> _dirs_removed;
224  std::set<string> _dirs_created;
225 
227  std::set<string> _packages_cannot_process;
228 
231  std::set<string, case_insensitive_cmp> _files_that_conflict;
232 
235  std::set<string> _existing_module_packages;
236 
238  triggers *_triggers;
239 
241  trigger_run *_trigger_run;
242 
244  trigger *_trigger;
245 
247  pkg::log *_log;
248 
250  std::tr1::function<void(LogCode code, const std::string &item, const std::string &what)> _warning;
251 
253  bool _state_text_changed;
255  std::string _state_text;
256 
257 public:
262  unpack(pkgbase& pb,const std::set<string>& packages);
263 
265  virtual ~unpack();
266 
271  { return _state; }
272 
276  size_type files_done() const
277  { return _files_done; }
278 
282  size_type files_total() const
283  { return _files_total; }
284 
288  size_type bytes_done() const
289  { return _bytes_done; }
290 
294  size_type bytes_total() const
295  { return _bytes_total; }
296 
302  string message() const
303  { return _message; }
304 
309  {
310  if (_state_text_changed) {_state_text_changed=false; return true;}
311  else return false;
312  }
313 
315  const std::string &state_text() const
316  { return _state_text; }
317 
324  const std::set<string>& packages_cannot_process() const
325  { return _packages_cannot_process; }
326 
333  const std::set<string, case_insensitive_cmp>& files_that_conflict() const
334  { return _files_that_conflict; }
335 
337  void use_trigger_run(trigger_run *tr);
338 
340  void log_to(pkg::log *use_log);
341 
343  void warning_func(std::tr1::function<void(LogCode code, const std::string &item, const std::string &what)> &f) {_warning = f;}
344 
351  triggers *detach_triggers();
352 
353 protected:
354  void poll();
355 private:
361  void _poll();
362 
364  void state(state_type new_state);
365 
367  void state_text(const std::string &text);
368 
375  void read_manifest(std::set<string>& mf,const string& pkgname);
376 
387  void build_manifest(std::set<string>& mf,zipfile& zf,size_type* usize=0);
388 
395  void prepare_manifest(std::set<string>& mf,const string& pkgname);
396 
402  void activate_manifest(const string& pkgname);
403 
409  void remove_manifest(const string& pkgname);
410 
414  void add_pre_install_trigger(const string &pkgname, bool has_unwind);
415 
419  void add_post_install_trigger(const string &pkgname);
420 
424  void add_pre_remove_trigger(const string &pkgname);
429  void set_post_install_unwind(const string &pkgname);
430 
436  void add_post_remove_trigger(const string &pkgname, std::set<std::string> &mf);
437 
445  void unpack_file(const string& src_pathname,const string& dst_pathname);
446 
454  void replace_file(const string& dst_pathname,bool overwrite);
455 
461  void remove_file(const string& dst_pathname);
462 
467  void remove_backup(const string& dst_pathname);
472  void unwind_remove_file(const string& dst_pathname);
473 
482  void unwind_replace_file(const string& dst_pathname,bool overwrite);
483 
488  void unwind_unpack_file(const string& dst_pathname);
489 
501  bool already_installed(const control& ctrl, const std::set<string> &mf);
502 
505  void update_existing_modules();
506 
508  void unwind_existing_modules();
509 
515  void get_trigger_versions(const std::string &pkgname, std::string &old_version, std::string &new_version);
516 
517  class cannot_process;
518  class file_conflict;
519  class file_info_not_found;
520  class riscos_info_not_found;
521 };
522 
523 }; /* namespace pkg */
524 
525 #endif
The state in which old versions of files are backed up and replaced with new versions.
Definition: unpack.h:71
size_type files_total() const
Get total number of files to process.
Definition: unpack.h:282
The state in which post remove triggers are run to unwind the actions of the pre install triggers...
Definition: unpack.h:97
A class to manage the package triggers executed during the commiting of the packages.
Definition: triggers.h:27
The state in which state_pre_remove is being backed out.
Definition: unpack.h:106
An exception class for reporting that a file information record could not be found.
Definition: unpack.cc:150
const std::set< string > & packages_cannot_process() const
Get the set of packages that cannot be processed.
Definition: unpack.h:324
The state in which state_pre_unpack is being backed out.
Definition: unpack.h:108
The state in which state_unpack is being backed out.
Definition: unpack.h:99
The state in which post install triggers are run to unwind the actions of the pre remove and/or pre i...
Definition: unpack.h:102
The namespace used to hold the package management library.
Definition: auto_dir.cc:12
const std::set< string, case_insensitive_cmp > & files_that_conflict() const
Get the set of destination pathnames that conflict with files already on the system.
Definition: unpack.h:333
bool operator()(const std::string &a, const std::string &b) const
Definition: unpack.h:32
An exception class for reporting that one or more files conflict with those already on the system...
Definition: unpack.cc:140
The state in which backups are deleted, and the states of packages to be removed are changed to statu...
Definition: unpack.h:78
size_type bytes_total() const
Get total number of bytes to process.
Definition: unpack.h:294
A class for unpacking and removing sets of packages.
Definition: unpack.h:38
size_type files_done() const
Get number of files processed.
Definition: unpack.h:276
The state in which files are unpacked from their zip archives and moved to temporary locations...
Definition: unpack.h:66
state_type
An enumeration for describing the state of the unpack operation.
Definition: unpack.h:49
A class for automatically creating and deleting directories.
Definition: auto_dir.h:20
The state in which the states of packages to be unpacked are changed to status::state_unpacked.
Definition: unpack.h:85
class to represent a trigger action from a script
Definition: trigger.h:22
bool clear_state_text_changed()
Check is state text has changed and clear the changed flag.
Definition: unpack.h:308
string message() const
Get error message.
Definition: unpack.h:302
The state in which empty diwas created are removed.
Definition: unpack.h:90
The state in which pre install triggers are run.
Definition: unpack.h:68
A class to represent the content of a RiscPkg control file.
Definition: control.h:24
A mixin class to represent a cooperative thread.
Definition: thread.h:12
Class to log actions that occur in LibPkg.
Definition: log.h:213
Interface to execute a trigger.
Definition: trigger.h:66
size_type bytes_done() const
Get number of bytes processed.
Definition: unpack.h:288
A class for representing the collection of package database tables.
Definition: pkgbase.h:24
An exception class for reporting that one or more packages cannot be processed.
Definition: unpack.cc:130
The state in which state_replace is being backed out.
Definition: unpack.h:94
The state in which any empty directwasries that need creating are created.
Definition: unpack.h:82
unsigned long long size_type
A type for representing byte counts.
Definition: unpack.h:43
The state in which the pre remove triggers are run.
Definition: unpack.h:63
Comparison that does not take into account the case of the string.
Definition: unpack.h:31
const char * dst_pathname
Definition: path_table.cc:21
const std::string & state_text() const
Return the current state text.
Definition: unpack.h:315
The state in which post remove trigger copies are removed.
Definition: unpack.h:104
The state in which all operations have been successfully completed.
Definition: unpack.h:88
The state in which post remove triggers are copied so they are preserved to be run after the packages...
Definition: unpack.h:61
The state in which old versions of files that do not have replacements are backed up then removed...
Definition: unpack.h:74
state_type state() const
Get current state of the unpack operation.
Definition: unpack.h:270
const char * src_pathname
Definition: path_table.cc:20
The state in which the states of packages to be removed are changed to status::state_half_unpacked.
Definition: unpack.h:58
An interface class to represent a zip file.
Definition: zipfile.h:20
The state in which state_remove is being backed out.
Definition: unpack.h:92
LogCode
An enumeration of all the items that can be logged.
Definition: log.h:19
The state in which the states of packages to be unpacked are changed to status::state_half_unpacked.
Definition: unpack.h:54
void warning_func(std::tr1::function< void(LogCode code, const std::string &item, const std::string &what)> &f)
Set the function to log and capture warnings.
Definition: unpack.h:343

Reference Manual LibPkg Version 0.6.1 (28 Jan 2015)