src/pkgbase.h

   1 #ifndef PKGBASE_H
   2 /*
   3  * pkgbase.h
   4  *
   5  * $Id$
   6  *
   7  * Written by Keith Marshall <keithmarshall@users.sourceforge.net>
   8  * Copyright (C) 2009, 2010, MinGW Project
   9  *
  10  *
  11  * Public interface for the package directory management routines;
  12  * declares the XML data structures, and their associated class APIs,
  13  * which are used to describe packages and their interdependencies.
  14  *
  15  *
  16  * This is free software.  Permission is granted to copy, modify and
  17  * redistribute this software, under the provisions of the GNU General
  18  * Public License, Version 3, (or, at your option, any later version),
  19  * as published by the Free Software Foundation; see the file COPYING
  20  * for licensing details.
  21  *
  22  * Note, in particular, that this software is provided "as is", in the
  23  * hope that it may prove useful, but WITHOUT WARRANTY OF ANY KIND; not
  24  * even an implied WARRANTY OF MERCHANTABILITY, nor of FITNESS FOR ANY
  25  * PARTICULAR PURPOSE.  Under no circumstances will the author, or the
  26  * MinGW Project, accept liability for any damages, however caused,
  27  * arising from the use of this software.
  28  *
  29  */
  30 #define PKGBASE_H  1
  31
  32 #include <tinyxml.h>
  33 #include <tinystr.h>
  34
  35 #ifndef EXTERN_C
  36 # ifdef __cplusplus
  37 #  define EXTERN_C extern "C"
  38 # else
  39 #  define EXTERN_C
  40 # endif
  41 #endif
  42
  43 /* Adopt sensible defaults for matching subsystem and file names...
  44  */
  45 #ifdef _WIN32
  46   /*
  47    * The MS-Windows file system is intrinsically case insensitive,
  48    * so we prefer to match both subsystem and file names in a case
  49    * insensitive manner...
  50    */
  51 # ifndef CASE_INSENSITIVE_SUBSYSTEMS
  52 #  define CASE_INSENSITIVE_SUBSYSTEMS  1
  53 # endif
  54 # ifndef CASE_INSENSITIVE_FILESYSTEM
  55 #  define CASE_INSENSITIVE_FILESYSTEM  1
  56 # endif
  57   /*
  58    * The preferred name for MS-Windows' case insensitive string
  59    * matching function, equivalent to POSIX strcasecmp().
  60    */
  61 # define strcasecmp  stricmp
  62 #else
  63   /* On other systems, we prefer to adopt case sensitive matching
  64    * strategies for subsystem and file names.
  65    */
  66 # ifndef CASE_INSENSITIVE_SUBSYSTEMS
  67 #  define CASE_INSENSITIVE_SUBSYSTEMS  0
  68 # endif
  69 # ifndef CASE_INSENSITIVE_FILESYSTEM
  70 #  define CASE_INSENSITIVE_FILESYSTEM  0
  71 # endif
  72 #endif
  73
  74 class pkgSpecs;
  75
  76 class pkgXmlNode : public TiXmlElement
  77 {
  78   /* A minimal emulation of the wxXmlNode class, founded on
  79    * the tinyxml implementation of the TiXmlElement class, and
  80    * subsequently extended by application specific features.
  81    */
  82   public:
  83     /* Constructors...
  84      */
  85     inline pkgXmlNode( const char* name ):TiXmlElement( name ){}
  86     inline pkgXmlNode( const pkgXmlNode& src ):TiXmlElement( src ){}
  87
  88     /* Accessors...
  89      *
  90      * Note that tinyxml is generally careless about checking for
  91      * possible dereferencing of NULL pointers; thus, many of these
  92      * wrappers include appropriate checks, to prevent this.
  93      */
  94     inline const char* GetName()
  95     {
  96       /* Retrieve the identifying name of the XML tag;
  97        * tinyxml calls this the element "value"...
  98        */
  99       return this ? Value() : NULL;
 100     }
 101     inline pkgXmlNode* GetParent()
 102     {
 103       /* wxXmlNode provides this equivalant of tinyxml's
 104        * Parent() method.
 105        */
 106       return this ? (pkgXmlNode*)(Parent()) : NULL;
 107     }
 108     inline pkgXmlNode* GetChildren()
 109     {
 110       /* wxXmlNode provides only this one method to access
 111        * the children of an element; it is equivalent to the
 112        * FirstChild() method in tinyxml's arsenal.
 113        */
 114       return this ? (pkgXmlNode*)(FirstChild()) : NULL;
 115     }
 116     inline pkgXmlNode* GetNext()
 117     {
 118       /* This is wxXmlNode's method for visiting other children
 119        * of an element, after the first found by GetChildren();
 120        * it is equivalent to tinyxml's NextSibling().
 121        */
 122       return this ? (pkgXmlNode*)(NextSibling()) : NULL;
 123     }
 124     inline const char* GetPropVal( const char* name, const char* subst )
 125     {
 126       /* tinyxml has no direct equivalent for this wxXmlNode method,
 127        * (which substitutes default "subst" text for an omitted property),
 128        * but it may be trivially emulated, using the Attribute() method.
 129        */
 130       const char* retval = this ? Attribute( name ) : subst;
 131       return retval ? retval : subst;
 132     }
 133     inline pkgXmlNode* AddChild( TiXmlNode *child )
 134     {
 135       /* This is wxXmlNode's method for adding a child node, it is
 136        * equivalent to tinyxml's LinkEndChild() method.
 137        */
 138       return this ? (pkgXmlNode*)(LinkEndChild( child )) : NULL;
 139     }
 140     inline bool DeleteChild( pkgXmlNode *child )
 141     {
 142       /* Both TiXmlNode and wxXmlNode have RemoveChild methods, but the
 143        * implementations are semantically different; for tinyxml, we may
 144        * simply use the RemoveChild method here, where for wxXmlNode, we
 145        * would use RemoveChild followed by `delete child'.
 146        */
 147       return this ? RemoveChild( child ) : false;
 148     }
 149
 150     /* Additional methods specific to the application.
 151      */
 152     inline pkgXmlNode *GetDocumentRoot()
 153     {
 154       /* Convenience method to retrieve a pointer to the document root.
 155        */
 156       return this ? (pkgXmlNode*)(GetDocument()->RootElement()) : NULL;
 157     }
 158     inline bool IsElementOfType( const char* tagname )
 159     {
 160       /* Confirm if the owner XML node represents a data element
 161        * with the specified "tagname".
 162        */
 163       return this ? strcmp( GetName(), tagname ) == 0 : false;
 164     }
 165
 166     /* Methods for retrieving the system root management records
 167      * for a specified installed subsystem.
 168      */
 169     pkgXmlNode *GetSysRoot( const char *subsystem );
 170     pkgXmlNode *GetInstallationRecord( const char* );
 171
 172     /* The following pair of methods provide an iterator
 173      * for enumerating the contained nodes, within the owner,
 174      * which themselves exhibit a specified tagname.
 175      */
 176     pkgXmlNode* FindFirstAssociate( const char* tagname );
 177     pkgXmlNode* FindNextAssociate( const char* tagname );
 178
 179     /* Specific to XML node elements of type "release",
 180      * the following pair of methods retrieve the actual name of
 181      * the release tarball, and its associated source code tarball,
 182      * as they are named on the project download servers.
 183      */
 184     const char* ArchiveName();
 185     const char* SourceArchiveName();
 186 };
 187
 188 enum { to_remove = 0, to_install, selection_types };
 189
 190 class pkgActionItem
 191 {
 192   /* A class implementing a bi-directionally linked list of
 193    * "action" descriptors, which is to be associated with the
 194    * pkgXmlDocument class, specifying actions to be performed
 195    * on the managed software installation.
 196    */
 197   private:
 198     /* Pointers to predecessor and successor in the linked list
 199      * comprising the schedule of action items.
 200      */
 201     pkgActionItem* prev;
 202     pkgActionItem* next;
 203
 204     /* Flags define the specific action associated with this item.
 205      */
 206     unsigned long flags;
 207
 208     /* Criteria for selection of package versions associated with
 209      * this action item.
 210      */
 211     const char* min_wanted;
 212     const char* max_wanted;
 213
 214     /* Pointers to the XML database entries for the package selected
 215      * for processing by this action.
 216      */
 217     pkgXmlNode* selection[ selection_types ];
 218
 219     /* Method for retrieving packages from a distribution server.
 220      */
 221     void DownloadArchiveFiles( pkgActionItem* );
 222
 223   public:
 224     /* Constructor...
 225      */
 226     pkgActionItem( pkgActionItem* = NULL, pkgActionItem* = NULL );
 227
 228     /* Methods for assembling action items into a linked list.
 229      */
 230     pkgActionItem* Append( pkgActionItem* = NULL );
 231     pkgActionItem* Insert( pkgActionItem* = NULL );
 232
 233     /* Methods for compiling the schedule of actions.
 234      */
 235     pkgActionItem* GetReference( pkgActionItem& );
 236     pkgActionItem* Schedule( unsigned long, pkgActionItem& );
 237
 238     /* Methods for defining the selection criteria for
 239      * packages to be processed.
 240      */
 241     pkgXmlNode* SelectIfMostRecentFit( pkgXmlNode* );
 242     const char* SetRequirements( pkgXmlNode*, pkgSpecs* );
 243     inline void SelectPackage( pkgXmlNode *pkg, int opt = to_install )
 244     {
 245       /* Mark a package as the selection for a specified action.
 246        */
 247       selection[ opt ] = pkg;
 248     }
 249     inline pkgXmlNode* Selection( int mode = to_install )
 250     {
 251       /* Retrieve the package selection for a specified action.
 252        */
 253       return selection[ mode ];
 254     }
 255
 256     /* Method for processing all scheduled actions.
 257      */
 258     void Execute();
 259
 260     /* Destructor...
 261      */
 262     ~pkgActionItem();
 263 };
 264
 265 class pkgXmlDocument : public TiXmlDocument
 266 {
 267   /* Minimal emulation of the wxXmlDocument class, founded on
 268    * the tinyxml implementation of the TiXmlDocument class.
 269    */
 270   public:
 271     /* Constructors...
 272      */
 273     inline pkgXmlDocument(){}
 274     inline pkgXmlDocument( const char* name )
 275     {
 276       /* tinyxml has a similar constructor, but unlike wxXmlDocument,
 277        * it DOES NOT automatically load the document; force it.
 278        */
 279       LoadFile( name );
 280
 281       /* Always begin with an empty actions list.
 282        */
 283       actions = NULL;
 284     }
 285
 286     /* Accessors...
 287      */
 288     inline bool IsOk()
 289     {
 290       /* tinyxml doesn't have this, but instead provides a complementary
 291        * `Error()' indicator, so to simulate `IsOk()'...
 292        */
 293       return ! Error();
 294     }
 295     inline pkgXmlNode* GetRoot()
 296     {
 297       /* This is wxXmlDocument's method for locating the document root;
 298        * it is equivalent to tinyxml's RootElement() method.
 299        */
 300       return (pkgXmlNode *)(RootElement());
 301     }
 302     inline void AddDeclaration
 303     ( const char *version, const char *encoding, const char *standalone )
 304     {
 305       /* Not a standard method of either wxXmlDocumemnt or TiXmlDocument;
 306        * this is a convenience method for setting up a new XML database.
 307        */
 308       LinkEndChild( new TiXmlDeclaration( version, encoding, standalone ) );
 309     }
 310     inline void SetRoot( TiXmlNode* root )
 311     {
 312       /* tinyxml has no direct equivalent for this wxXmlDocument method;
 313        * to emulate it, we must first explicitly delete an existing root
 314        * node, if any, then link the new root node as a document child.
 315        */
 316       pkgXmlNode *oldroot;
 317       if( (oldroot = GetRoot()) != NULL )
 318         delete oldroot;
 319       LinkEndChild( root );
 320     }
 321     inline bool Save( const char *filename )
 322     {
 323       /* This wxXmlDocument method for saving the database is equivalent
 324        * to the corresponding tinyxml SaveFile( const char* ) method.
 325        */
 326       return SaveFile( filename );
 327     }
 328
 329   private:
 330     /* Properties specifying the schedule of actions.
 331      */
 332     unsigned long request;
 333     pkgActionItem* actions;
 334
 335   public:
 336     /* Method to synchronise the state of the local package manifest
 337      * with the master copy held on the distribution server.
 338      */
 339     void SyncRepository( const char*, pkgXmlNode* );
 340
 341     /* Method to merge content from repository-specific package lists
 342      * into the central XML package database.
 343      */
 344     pkgXmlNode* BindRepositories( bool );
 345
 346     /* Method to load the system map, and the lists of installed
 347      * packages associated with each specified sysroot.
 348      */
 349     void LoadSystemMap();
 350
 351     /* Complementary method, to update the saved sysroot data associated
 352      * with the active system map.
 353      */
 354     void UpdateSystemMap();
 355
 356     /* Method to locate the XML database entry for a named package.
 357      */
 358     pkgXmlNode* FindPackageByName( const char*, const char* = NULL );
 359
 360     /* Method to resolve the dependencies of a specified package,
 361      * by walking the chain of references specified by "requires"
 362      * elements in the respective package database entries.
 363      */
 364     void ResolveDependencies( pkgXmlNode*, pkgActionItem* = NULL );
 365
 366     /* Methods for compiling a schedule of actions.
 367      */
 368     void Schedule( unsigned long, const char* );
 369     pkgActionItem* Schedule( unsigned long, pkgActionItem&, pkgActionItem* = NULL );
 370
 371     /* Method to execute a sequence of scheduled actions.
 372      */
 373     inline void ExecuteActions(){ actions->Execute(); }
 374 };
 375
 376 EXTERN_C const char *xmlfile( const char*, const char* = NULL );
 377 EXTERN_C int has_keyword( const char*, const char* );
 378
 379 typedef int (*strcmp_function)( const char *, const char * );
 380
 381 static inline
 382 bool safe_strcmp( strcmp_function strcmp, const char *value, const char *proto )
 383 {
 384   /* Helper to compare a pair of "C" strings for equality,
 385    * accepting NULL as a match for anything; for non-NULL matches,
 386    * case sensitivity is determined by choice of strcmp function.
 387    *
 388    * N.B. Unlike the 'strcmp' function which this calls, this is
 389    * a boolean function, returning TRUE when the 'strcmp' result
 390    * is zero, (i.e. the sense of the result is inverted).
 391    */
 392   return (value == NULL) || (proto == NULL) || (strcmp( value, proto ) == 0);
 393 }
 394
 395 /* Define a safe_strcmp() alias for an explicitly case sensitive match.
 396  */
 397 #define match_if_explicit( A, B )  safe_strcmp( strcmp, (A), (B) )
 398
 399 /* Further safe_strcmp() aliases provide for matching subsystem names,
 400  * with implementation dependent case sensitivity...
 401  */
 402 #if CASE_INSENSITIVE_SUBSYSTEMS
 403 # define subsystem_strcmp( A, B )  safe_strcmp( strcasecmp, (A), (B) )
 404 #else
 405 # define subsystem_strcmp( A, B )  safe_strcmp( strcmp, (A), (B) )
 406 #endif
 407
 408 /* ...and similarly, for matching of file names.
 409  */
 410 #if CASE_INSENSITIVE_FILESYSTEM
 411 # define pkg_strcmp( A, B )  safe_strcmp( strcasecmp, (A), (B) )
 412 #else
 413 # define pkg_strcmp( A, B )  safe_strcmp( strcmp, (A), (B) )
 414 #endif
 415
 416 #endif /* PKGBASE_H: $RCSfile$: end of file */