dca_interface  6.3.4
wac_samples/wacdbdownloadsample/main.cpp
1 /* IBM Source Code */
2 /* (C) Copyright IBM Corp. 2009, 2012 */
3 /* Licensed Materials - Property of IBM */
4 /* US Government Users Restricted Rights - Use duplication or disclosure restricted by GSA Schedule Contract with IBM Corp. */
5 
33 #include <cstdlib>
34 #include <string>
35 #include <iostream>
36 #include <fstream>
37 
38 #include "dca/dca_base.h"
39 #include "dca/dca_callbacks.h"
41 
43 
44 using namespace dca;
45 using namespace dca_wac;
46 
47 const std::string S_ToolName = "wacdbdownloadsample";
48 const std::string S_ToolVersion = "1.2";
49 
54 const std::string S_UsageString =
55  " <redist-folder> <ticket> <product>\n"
56  " redist-folder - the folder where the DCA is installed to\n"
57  " ticket - a valid ticket\n"
58  " product - the product associated with your ticket\n\n"
59  ;
60 
65 #ifdef WIN32
66 # define DCA_BINDIR "bin/Win32"
67 #else
68 # define DCA_BINDIR "bin/linux"
69 #endif
70 
75 #define DCA_INITDIR "init"
76 
80 #define DCA_LOGDIR "./logs"
81 
92 static void SetupInitData( const std::string& redist_folder, InitData& initData )
93 {
94  initData.binDir = redist_folder + DCA_BINDIR;
95  initData.initDir = redist_folder + DCA_INITDIR;
96  initData.logDir = DCA_LOGDIR;
97 }
98 
106 static void SetupLicense( const std::string& ticket, const std::string& product,
107  LicenseData& licenseData )
108 {
109  licenseData.ticket = ticket;
110  licenseData.product = product;
111 }
112 
118 static void SetupConnectionData( DbConnectionData& cData )
119 {
120  cData.useLocalDatabase = true;
121  cData.dbType = DBT_Wac;
122 }
123 
128 static void PrintToolHeader()
129 {
130  std::cout << "IBM DCA Sample: " << S_ToolName << " (" << S_ToolVersion << ")"
131  << std::endl;
132 }
133 
139 static void PrintUsage( const char *name )
140 {
141  std::cout << "usage: " << name << S_UsageString << std::endl;
142 }
143 
149 static void PrintUpdateResults( const UpdateResults& results )
150 {
151  std::cout << "UpdateResults: size=" << results.size() << ", restartRequired="
152  << ( results.restartRequired() ? "true" : "false" )
153  << std::endl;
154 
155  if( !results.size() ) {
156  std::cout << "Currently there are no updates available" << std::endl;
157  return;
158  }
159 
160  // iterate through all received updates and print out the details
161  const DCA_SIZE_TYPE size = results.size();
162 
163  for( DCA_INDEX_TYPE i = 0; i < size; ++i ) {
164  const UpdateResult result = results[i];
165 
166  std::cout << "Result #" << i << " id=" << result.id() << ", contentUpdated="
167  << ( result.contentUpdated() ? "true" : "false" ) << ", engineUpdated="
168  << ( result.engineUpdated() ? "true" : "false" ) << std::endl;
169 
170  const DCA_SIZE_TYPE numDetals = result.size();
171 
172  for( DCA_INDEX_TYPE j = 0; j < numDetals; ++j ) {
173  const UpdateResultDetail detail = result[j];
174 
175  std::string returnMsg = "internal error";
176  if( detail.returnCode() == DCA_UPDATE_DOWNLOAD_SCHEDULED ) {
177  returnMsg = "download scheduled";
178  }
179  else if( detail.returnCode() == 0 ) {
180  returnMsg = "success";
181  }
182 
183  std::cout << " Detail #" << j << ":"
184  << "\n component=" << detail.component()
185  << "\n old version=" << detail.oldVersion()
186  << "\n new version=" << detail.newVersion()
187  << "\n available=" << ( detail.available() ? "true" : "false" )
188  << "\n downloaded=" << ( detail.downloaded() ? "true" : "false" )
189  << "\n installed=" << ( detail.installed() ? "true" : "false" )
190  << "\n return=" << returnMsg << std::endl;
191  }
192  }
193 }
194 
214 static int PerformUpdateAndSchedule( const DcaInstance& myDca, const DbConnection& myDbConnection, const UpdateModule& myUpdateModule )
215 {
216  const std::string current_db_version = myDbConnection.getDatabaseVersion();
217 
218  // call UpdateModule::performUpdate
219  std::cout << "Starting update process, paramater force is set to 'false'..."
220  << std::endl;
221 
222  UpdateResults results;
223  FunctionResult myFR = myUpdateModule.performUpdate( false, results );
224  if( !myFR ) {
225  // we encounter an error... print detailed error code and return
226  std::cerr << "Got error from update. Details: '" << myFR.getDescription()
227  << "' (" << myFR.getReturnCode() << "). Aborting." << std::endl;
228  return 1;
229  }
230 
231  PrintUpdateResults( results );
232 
233  // set up an instance of MyWacScheduleEventSubscriber to capture and log the
234  // schedule event information
235  std::cout << std::endl << "Starting schedule process..." << std::endl;
236  MyWacScheduleEventSubscriber mySubscriber;
237  myFR = myDca.schedule( &mySubscriber );
238  if( !myFR ) {
239  // we encounter an error... print detailed error code and return
240  std::cerr << "Received error from schedule. Details: '" << myFR.getDescription()
241  << "' (" << myFR.getReturnCode() << ")." << std::endl;
242  return 2;
243  }
244 
245  const std::string new_db_version = myDbConnection.getDatabaseVersion();
246 
247  std::cout << "Database has been updated from version " << current_db_version << " to " << new_db_version << std::endl;
248  return 0;
249 }
250 
258 int main( int argc, char *argv[] )
259 {
260  PrintToolHeader();
261 
262  int rc = 0;
263 
264  try {
265 
266  if( argc < 4 ) {
267  PrintUsage( argv[0] );
268  return 5;
269  }
270 
271  std::string myRedistFolder = argv[ 1 ];
272  const std::string myTicket = argv[ 2 ];
273  const std::string myProduct = argv[ 3 ];
274 
275  if( myRedistFolder.empty() || myTicket.empty() ||
276  myProduct.empty() ) {
277  PrintUsage( argv[0] );
278  return 5;
279  }
280 
281  // check for traling fileslash - and add if necessary
282  const char c = myRedistFolder[ myRedistFolder.length() - 1 ];
283  if( c != '/' && c != '\\' )
284  myRedistFolder += "/";
285 
286  // init the 3rd party libraries
287  InitCUrl();
289 
290  {
291  // setup DCA directories
292  InitData myInitData;
293  SetupInitData( myRedistFolder, myInitData );
294 
295  // instantiate DCA API
296  DcaInstance myDca;
297  myDca = DcaInstance::create( myInitData );
298 
299  // setup license data
300  LicenseData myLicenseData;
301  SetupLicense( myTicket, myProduct, myLicenseData );
302  const License myLicense = myDca.createLicense( myLicenseData );
303 
304  if( !myLicense.isLicensed( UpdateModule::ID ) ) {
305  std::cout << "DCA is not licensed!" << std::endl;
306  rc = 5;
307  }
308  else {
309  // setup a signature database connection
310  DbConnectionData myDbConnectionData;
311  SetupConnectionData( myDbConnectionData );
312  const DbConnection myDbConnection = myDca.createDbConnection( myLicense, myDbConnectionData );
313 
314  // create the WAC classification, classifier and categories info modules
315  const WacClassification myWacClassification = WacClassification::create( myDca, myLicense);
316  const WacCategoriesInfo myWacCategoriesInfo = myWacClassification.getCategoriesInfo();
317  const WacClassifier myWacClassifier = myWacClassification.createClassifier( myDbConnection );
318 
319  // create the update module
320  const UpdateModule myUpdateModule = UpdateModule::create( myDca, myLicense );
321 
322  // call performUpdate and schedule functions to update active components
323  rc = PerformUpdateAndSchedule( myDca, myDbConnection, myUpdateModule );
324  }
325  }
326  }
327  catch( const ExDca& ex ) {
328  std::cerr << "DCA Exception occured. Details: " << ex.getDescription() <<
329  " (" << ex.getReturnCode() << ")." << std::endl;
330  rc = 10;
331  }
332  catch( const std::exception& s ) {
333  std::cerr << "std::exception occured. Details: " << s.what() << "." << std::endl;
334  rc = 10;
335  }
336  catch(...) {
337  std::cerr << "Unknown exception caught." << std::endl;
338  rc = 10;
339  }
340 
341  // deinit the 3rd party libraries
343  DeinitCUrl();
344 
345  return rc;
346 }
347 
348 
349 
Is used to create a License object. A license first must be created with DcaInstance::createLicense t...
Definition: base_classes.h:547
Exception class used in the DCA.
Definition: base_classes.h:237
std::string oldVersion() const
Returns the version active (installed) before the update was invoked.
void InitCUrl()
Initializes libcurl. Do not use any DCA function before initializing libcurl.
std::string initDir
the directory in which the DCA init files are stored
Definition: base_classes.h:266
FunctionResult schedule(ScheduleEventSubscriberIntf *pScheduleEventSubscriber=NULL) const
Invokes scheduled tasks, e.g. Database updates and processes that can take a long time.
static UpdateModule create(const DcaInstance &aDcaInstance, const License &aLicense, const ProxySettings &proxySettings=ProxySettings())
std::string getDescription() const
Returns a description of the error.
bool downloaded() const
true if an update sucessfully downloaded for this component, false otherwise
int returnCode() const
The internal code of the update, this can be any internal error code, 0 in case of success or DCA_UPD...
Encapsulates the details of a result of an update process.
DCA_RESULT_TYPE getReturnCode() const
Returns the last error code (if any).
bool restartRequired() const
true if an update has been installed that requires a restart of the DCA, false otherwise.
static void SetupInitData(const std::string &redist_folder, InitData &initData)
Sets up the given initData by substituting the given redist_folder with DCA subdirectories.
The update module is used to download and install DCA content and engine updates.
Definition: base_classes.h:917
bool installed() const
true if an update sucessfully installed for this component, false otherwise
std::string binDir
the directory in which the DCA binary (*.dca) files are stored
Definition: base_classes.h:265
This header includes initialization/deinitialization support functions for the 3rd party libraries us...
Encapsulates the results of an update process.
Definition: base_classes.h:998
Header file for the schedule event subscriber.
void SetOpenSslCallbacks()
Initializes the required callbacks for OpenSSL when using HTTPS or SSL connections in a multi-threade...
Stores the connection data for a database.
Definition: base_classes.h:815
void UnsetOpenSslCallbacks()
Unsets the openssl callbacks. Do not call any DCA function after you have called this function.
const int DCA_UPDATE_DOWNLOAD_SCHEDULED
Internal DCA status code to indicate that a potentially time consuming download has been scheduled....
void DeinitCUrl()
Deinitializes libcurl. Do not call any DCA function after you have called this function.
Database connection class for a local or remote database.
Definition: base_classes.h:859
WacCategoriesInfo getCategoriesInfo() const
Retrieve the WacCategoriesInfo class.
bool contentUpdated() const
If true the update(s) include a content update.
#define DCA_LOGDIR
Relative directory for logfile(s).
Package header file for the WAC (Web Application Classification) Package.
#define DCA_INITDIR
DCA subdirectory of the DCA initialization data.
DCA_RESULT_TYPE getReturnCode() const
Gets the code of the error.
std::string newVersion() const
Returns the version currently active (installed).
bool available() const
true if an update was available for this component, false otherwise
Defintion of the WacClassifier class.
Encapsulates one of the results of an update process.
static void PrintToolHeader()
Prints out the name and the version of this sample.
Defintion of the WacClassification class.
Use a License to initialize a classification package or a toolbox package.
Definition: base_classes.h:560
const DbType DBT_Wac
Used for dca::DbConnection classes for Web Application Classification databases.
Container class for all WAC enumeration objects.
FunctionResult performUpdate(bool force, UpdateResults &results) const
Performs an update for all licensed and initialized DCA modules and classifiers.
bool isLicensed(DCA_MODULE_ID_TYPE id=0, bool force=false) const
Checks whether the given License is valid for the given module id.
std::string ticket
The ticket as provided in the license.
Definition: base_classes.h:548
This header includes all header files of the DCA Base Package.
bool useLocalDatabase
Set to true to connect to a local or custom database, set to false to use a remote database.
Definition: base_classes.h:821
Encapsulates the init and deinit of the DCA API.
Definition: base_classes.h:315
std::string product
The product code used with the license.
Definition: base_classes.h:549
static DCA_MODULE_ID_TYPE ID
This is the module id of the update module.
Definition: base_classes.h:920
WacClassifier createClassifier(const dca::DbConnection &aDbConnection, const WacClassifierOptions &aWacClassifierOptions=WacClassifierOptions()) const
Creates a WacClassifier that is used to classify WacInputData objects.
std::string logDir
the directory in which the DCA log file should be created
Definition: base_classes.h:267
static void PrintUsage(const char *name)
Prints out the syntax of the sample.
size_t DCA_INDEX_TYPE
Type for index access (used for arrays and collections).
Definition: base_types.h:66
DbType dbType
The type of the database.
Definition: base_classes.h:820
DCA_SIZE_TYPE size() const
Returns the number of available details (if any).
std::string getDescription() const
Returns the description for the error or warning.
size_t DCA_SIZE_TYPE
Type for size (used for size of array and collections).
Definition: base_types.h:72
bool engineUpdated() const
If true the update(s) include an engine update.
#define DCA_BINDIR
DCA subdirectory of the DCA binaries.
Standard function result.
Definition: base_classes.h:148
Example implementation of a schedule event subscriber.
const std::string S_UsageString
Usage string, displayed if a parameter is missing.
DbConnection createDbConnection(const License &aLicense, const DbConnectionData &dbcData, const ProxySettings &proxySettings=ProxySettings(), LogLevel aLogLevel=LOG_Initial) const
Creates a DbConnection object using the given DbConnectionData.
This structure is used to initialize the DcaInstance.
Definition: base_classes.h:264
std::string getDatabaseVersion() const
Returns the currently used database version.
static DcaInstance create(const InitData &initData)
Creates a DcaInstance, starts up the DCA API and initializes the required main module.
DCA_SIZE_TYPE size() const
Returns the number of results available .
static void SetupLicense(const std::string &ticket, const std::string &product, LicenseData &licenseData)
Sets up the given licenseData by copying the given ticket and product strings.
License createLicense(const LicenseData &licData, const ProxySettings &proxySettings=ProxySettings(), LogLevel aLogLevel=LOG_Initial) const
Creates a License object using the given LicenseData.
DCA_MODULE_ID_TYPE id() const
Returns the module ID for which the updates have been installed.
std::string component() const
Returns the name of the component the detail applies to.
int main(int argc, char *argv[])
The main routine.