dca_interface  6.3.4
ipr_samples/iprdbdownloadsample/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_ipr;
46 
47 const std::string S_ToolName = "iprdbdownloadsample";
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_Ipr;
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 << "Start update process, paramater force is set to 'false'..."
220  << std::endl;
221  UpdateResults results;
222  FunctionResult myFR = myUpdateModule.performUpdate( false, results );
223  if( !myFR ) {
224  // we encounter an error... print detailed error code and return
225  std::cerr << "Got error from update. Details: '" << myFR.getDescription()
226  << "' (" << myFR.getReturnCode() << "). Aborting." << std::endl;
227  return 1;
228  }
229 
230  PrintUpdateResults( results );
231 
232  // set up an instance of MyIprScheduleEventSubscriber to capture and log the
233  // schedule event information
234  std::cout << std::endl << "Starting schedule process..." << std::endl;
235  MyIprScheduleEventSubscriber mySubscriber;
236  myFR = myDca.schedule( &mySubscriber );
237  if( !myFR ) {
238  // we encounter an error... print detailed error code and return
239  std::cerr << "Received error from schedule. Details: '" << myFR.getDescription()
240  << "' (" << myFR.getReturnCode() << ")." << std::endl;
241  return 2;
242  }
243 
244  const std::string new_db_version = myDbConnection.getDatabaseVersion();
245 
246  std::cout << "Database has been updated from version " << current_db_version << " to " << new_db_version << std::endl;
247  return 0;
248 }
249 
257 int main( int argc, char *argv[] )
258 {
259  PrintToolHeader();
260 
261  int rc = 0;
262 
263  try {
264 
265  if( argc < 4 ) {
266  PrintUsage( argv[0] );
267  return 5;
268  }
269 
270  std::string myRedistFolder = argv[ 1 ];
271  const std::string myTicket = argv[ 2 ];
272  const std::string myProduct = argv[ 3 ];
273 
274  if( myRedistFolder.empty() || myTicket.empty() ||
275  myProduct.empty() ) {
276  PrintUsage( argv[0] );
277  return 5;
278  }
279 
280  // check for traling fileslash - and add if necessary
281  const char c = myRedistFolder[ myRedistFolder.length() - 1 ];
282  if( c != '/' && c != '\\' )
283  myRedistFolder += "/";
284 
285  // init the 3rd party libraries
286  InitCUrl();
288 
289  {
290  // setup DCA directories
291  InitData myInitData;
292  SetupInitData( myRedistFolder, myInitData );
293 
294  // instantiate DCA API
295  DcaInstance myDca;
296  myDca = DcaInstance::create( myInitData );
297 
298  // setup license data
299  LicenseData myLicenseData;
300  SetupLicense( myTicket, myProduct, myLicenseData );
301  const License myLicense = myDca.createLicense( myLicenseData );
302 
303  if( !myLicense.isLicensed( UpdateModule::ID ) ) {
304  std::cout << "DCA is not licensed!" << std::endl;
305  rc = 5;
306  }
307  else {
308  // setup a signature database connection
309  DbConnectionData myDbConnectionData;
310  SetupConnectionData( myDbConnectionData );
311  const DbConnection myDbConnection = myDca.createDbConnection( myLicense, myDbConnectionData );
312 
313  // initialize the IPR classification, classifier and categories info modules
314  const IprClassification myIprClassification = IprClassification::create( myDca, myLicense );
315  const IprCategoriesInfo myCategoriesInfo = myIprClassification.getCategoriesInfo();
316  const IprClassifier myClassifier = myIprClassification.createClassifier( myDbConnection );
317 
318  // create the update module
319  const UpdateModule myUpdateModule = UpdateModule::create( myDca, myLicense );
320 
321  // call performUpdate and schedule functions to update active components
322  rc = PerformUpdateAndSchedule( myDca, myDbConnection, myUpdateModule );
323  }
324  }
325  }
326  catch( const ExDca& ex ) {
327  std::cerr << "DCA Exception occured. Details: " << ex.getDescription() <<
328  " (" << ex.getReturnCode() << ")." << std::endl;
329  rc = 10;
330  }
331  catch( const std::exception& s ) {
332  std::cerr << "std::exception occured. Details: " << s.what() << "." << std::endl;
333  rc = 10;
334  }
335  catch(...) {
336  std::cerr << "Unknown exception caught." << std::endl;
337  rc = 10;
338  }
339 
340  // deinit the 3rd party libraries
342  DeinitCUrl();
343 
344  return rc;
345 }
346 
347 
348 
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.
Defintion of the IprClassifier class.
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
Container class for all IPR enumeration objects.
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.
const DbType DBT_Ipr
Used to specify an IP Classification database when creating a dca::DbConnection instance.
Database connection class for a local or remote database.
Definition: base_classes.h:859
Package header file for the IPR (IP Reputation) Classification Package.
bool contentUpdated() const
If true the update(s) include a content update.
#define DCA_LOGDIR
Relative directory for logfile(s).
#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
Encapsulates one of the results of an update process.
static void PrintToolHeader()
Prints out the name and the version of this sample.
Use a License to initialize a classification package or a toolbox package.
Definition: base_classes.h:560
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
Example implementation of a schedule event subscriber.
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
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).
IprClassifier createClassifier(const dca::DbConnection &aDbConnection, const IprClassifierOptions &aIprClassifierOptions=IprClassifierOptions()) const
Creates a IprClassifier that is used to classify dca_ipr::Ip objects.
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.
Definition of the IprClassification class.
#define DCA_BINDIR
DCA subdirectory of the DCA binaries.
Standard function result.
Definition: base_classes.h:148
IprCategoriesInfo getCategoriesInfo() const
Retrieve the IprCategoriesInfo class.
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.