STEER/AliCDBStorage.cxx

   1 /**************************************************************************
   2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   3  *                                                                        *
   4  * Author: The ALICE Off-line Project.                                    *
   5  * Contributors are mentioned in the code where appropriate.              *
   6  *                                                                        *
   7  * Permission to use, copy, modify and distribute this software and its   *
   8  * documentation strictly for non-commercial purposes is hereby granted   *
   9  * without fee, provided that the above copyright notice appears in all   *
  10  * copies and that both the copyright notice and this permission notice   *
  11  * appear in the supporting documentation. The authors make no claims     *
  12  * about the suitability of this software for any purpose. It is          *
  13  * provided "as is" without express or implied warranty.                  *
  14  **************************************************************************/
  15
  16 #include <TKey.h>
  17 #include <TH1.h>
  18 #include "AliCDBManager.h"
  19 #include "AliCDBStorage.h"
  20
  21 #include "AliCDBEntry.h"
  22 #include "AliLog.h"
  23
  24 ClassImp(AliCDBStorage)
  25
  26 //_____________________________________________________________________________
  27 AliCDBStorage::AliCDBStorage():
  28 fValidFileIds(),
  29 fRun(-1),
  30 fPathFilter(),
  31 fVersion(-1),
  32 fMetaDataFilter(0),
  33 fSelections(),
  34 fURI(),
  35 fType(),
  36 fBaseFolder()
  37 {
  38 // constructor
  39
  40         fValidFileIds.SetOwner(1);
  41         fSelections.SetOwner(1);
  42 }
  43
  44 //_____________________________________________________________________________
  45 AliCDBStorage::~AliCDBStorage() {
  46 // destructor
  47
  48         RemoveAllSelections();
  49         fValidFileIds.Clear();
  50         delete fMetaDataFilter;
  51
  52 }
  53
  54 //_____________________________________________________________________________
  55 void AliCDBStorage::GetSelection(/*const*/ AliCDBId* id) {
  56 // return required version and subversion from the list of selection criteria
  57
  58         TIter iter(&fSelections);
  59         AliCDBId* aSelection;
  60
  61         // loop on the list of selection criteria
  62         while ((aSelection = (AliCDBId*) iter.Next())) {
  63                 // check if selection element contains id's path and run (range)
  64                 if (aSelection->Comprises(*id)) {
  65                         AliDebug(2,Form("Using selection criterion: %s ", aSelection->ToString().Data()));
  66                         // return required version and subversion
  67
  68                         id->SetVersion(aSelection->GetVersion());
  69                         id->SetSubVersion(aSelection->GetSubVersion());
  70                         return;
  71                 }
  72         }
  73
  74         // no valid element is found in the list of selection criteria -> return
  75         AliDebug(2,"Looking for objects with most recent version");
  76         return;
  77 }
  78
  79 //_____________________________________________________________________________
  80 void AliCDBStorage::ReadSelectionFromFile(const char *fileName){
  81 // read selection criteria list from file
  82
  83         RemoveAllSelections();
  84
  85         TList *list = GetIdListFromFile(fileName);
  86         if(!list) return;
  87
  88         list->SetOwner();
  89         Int_t nId = list->GetEntries();
  90         AliCDBId *id;
  91         TKey *key;
  92
  93         for(int i=nId-1;i>=0;i--){
  94                 key = (TKey*) list->At(i);
  95                 id = (AliCDBId*) key->ReadObj();
  96                 if(id) AddSelection(*id);
  97         }
  98         delete list;
  99         AliInfo(Form("Selection criteria list filled with %d entries",fSelections.GetEntries()));
 100         PrintSelectionList();
 101
 102 }
 103
 104 //_____________________________________________________________________________
 105 void AliCDBStorage::AddSelection(const AliCDBId& selection) {
 106 // add a selection criterion
 107
 108         AliCDBPath path = selection.GetPath();
 109         if(!path.IsValid()) return;
 110
 111         TIter iter(&fSelections);
 112         const AliCDBId *anId;
 113         while((anId = (AliCDBId*) iter.Next())){
 114                 if(selection.Comprises(*anId)){
 115                         AliWarning("This selection is more general than a previous one and will hide it!");
 116                         AliWarning(Form("%s", (anId->ToString()).Data()));
 117                         fSelections.AddBefore(anId, new AliCDBId(selection));
 118                         return;
 119                 }
 120
 121         }
 122         fSelections.AddFirst(new AliCDBId(selection));
 123 }
 124
 125 //_____________________________________________________________________________
 126 void AliCDBStorage::AddSelection(const AliCDBPath& path,
 127         const AliCDBRunRange& runRange, Int_t version, Int_t subVersion){
 128 // add a selection criterion
 129
 130         AddSelection(AliCDBId(path, runRange, version, subVersion));
 131 }
 132
 133 //_____________________________________________________________________________
 134 void AliCDBStorage::AddSelection(const AliCDBPath& path,
 135         Int_t firstRun, Int_t lastRun, Int_t version, Int_t subVersion){
 136 // add a selection criterion
 137
 138         AddSelection(AliCDBId(path, firstRun, lastRun, version, subVersion));
 139 }
 140
 141 //_____________________________________________________________________________
 142 void AliCDBStorage::RemoveSelection(const AliCDBId& selection) {
 143 // remove a selection criterion
 144
 145         TIter iter(&fSelections);
 146         AliCDBId* aSelection;
 147
 148         while ((aSelection = (AliCDBId*) iter.Next())) {
 149                 if (selection.Comprises(*aSelection)) {
 150                         fSelections.Remove(aSelection);
 151                 }
 152         }
 153 }
 154
 155 //_____________________________________________________________________________
 156 void AliCDBStorage::RemoveSelection(const AliCDBPath& path,
 157         const AliCDBRunRange& runRange){
 158 // remove a selection criterion
 159
 160         RemoveSelection(AliCDBId(path, runRange, -1, -1));
 161 }
 162
 163 //_____________________________________________________________________________
 164 void AliCDBStorage::RemoveSelection(const AliCDBPath& path,
 165         Int_t firstRun, Int_t lastRun){
 166 // remove a selection criterion
 167
 168         RemoveSelection(AliCDBId(path, firstRun, lastRun, -1, -1));
 169 }
 170
 171 //_____________________________________________________________________________
 172 void AliCDBStorage::RemoveSelection(int position){
 173 // remove a selection criterion from its position in the list
 174
 175         delete fSelections.RemoveAt(position);
 176 }
 177
 178 //_____________________________________________________________________________
 179 void AliCDBStorage::RemoveAllSelections(){
 180 // remove all selection criteria
 181
 182         fSelections.Clear();
 183 }
 184
 185 //_____________________________________________________________________________
 186 void AliCDBStorage::PrintSelectionList(){
 187 // prints the list of selection criteria
 188
 189         TIter iter(&fSelections);
 190         AliCDBId* aSelection;
 191
 192         // loop on the list of selection criteria
 193         int index=0;
 194         while ((aSelection = (AliCDBId*) iter.Next())) {
 195                 AliInfo(Form("index %d -> selection: %s",index++, aSelection->ToString().Data()));
 196         }
 197
 198 }
 199
 200 //_____________________________________________________________________________
 201 AliCDBEntry* AliCDBStorage::Get(const AliCDBId& query) {
 202 // get an AliCDBEntry object from the database
 203
 204         // check if query's path and runRange are valid
 205         // query is invalid also if version is not specified and subversion is!
 206         if (!query.IsValid()) {
 207                 AliError(Form("Invalid query: %s", query.ToString().Data()));
 208                 return NULL;
 209         }
 210
 211         // query is not specified if path contains wildcard or runrange = [-1,-1]
 212         if (!query.IsSpecified()) {
 213                 AliError(Form("Unspecified query: %s",
 214                                 query.ToString().Data()));
 215                 return NULL;
 216         }
 217
 218         // This is needed otherwise TH1  objects (histos, TTree's) are lost when file is closed!
 219         Bool_t oldStatus = TH1::AddDirectoryStatus();
 220         TH1::AddDirectory(kFALSE);
 221
 222         AliCDBEntry* entry = GetEntry(query);
 223
 224         if (oldStatus != kFALSE)
 225                 TH1::AddDirectory(kTRUE);
 226
 227         if (entry) {
 228                 // this is to make the SHUTTLE output lighter
 229                 if(!(query.GetPath().Contains("SHUTTLE/STATUS")))
 230                         AliInfo(Form("CDB object retrieved: %s", entry->GetId().ToString().Data()));
 231         } else {
 232                 // this is to make the SHUTTLE output lighter
 233                 if(!(query.GetPath().Contains("SHUTTLE/STATUS")))
 234                         AliInfo(Form("No valid CDB object found! request was: name = <%s>, run = %d",
 235                                 (query.GetPath()).Data(), query.GetFirstRun()));
 236         }
 237
 238         // if drain storage is set, drain entry into drain storage
 239         if(entry && (AliCDBManager::Instance())->IsDrainSet())
 240                 AliCDBManager::Instance()->Drain(entry);
 241
 242         return entry;
 243 }
 244
 245 //_____________________________________________________________________________
 246 AliCDBEntry* AliCDBStorage::Get(const AliCDBPath& path, Int_t runNumber,
 247         Int_t version, Int_t subVersion) {
 248 // get an AliCDBEntry object from the database
 249
 250         return Get(AliCDBId(path, runNumber, runNumber, version, subVersion));
 251 }
 252
 253 //_____________________________________________________________________________
 254 AliCDBEntry* AliCDBStorage::Get(const AliCDBPath& path,
 255         const AliCDBRunRange& runRange, Int_t version,
 256         Int_t subVersion) {
 257 // get an AliCDBEntry object from the database
 258
 259         return Get(AliCDBId(path, runRange, version, subVersion));
 260 }
 261
 262 //_____________________________________________________________________________
 263 TList* AliCDBStorage::GetAll(const AliCDBId& query) {
 264 // get multiple AliCDBEntry objects from the database
 265
 266
 267         if (!query.IsValid()) {
 268                 AliError(Form("Invalid query: %s", query.ToString().Data()));
 269                 return NULL;
 270         }
 271
 272         if (query.IsAnyRange()) {
 273                 AliError(Form("Unspecified run or runrange: %s",
 274                                 query.ToString().Data()));
 275                 return NULL;
 276         }
 277
 278         // This is needed otherwise TH1  objects (histos, TTree's) are lost when file is closed!
 279         Bool_t oldStatus = TH1::AddDirectoryStatus();
 280         TH1::AddDirectory(kFALSE);
 281
 282         TList *result = GetEntries(query);
 283
 284         if (oldStatus != kFALSE)
 285                 TH1::AddDirectory(kTRUE);
 286
 287         Int_t nEntries = result->GetEntries();
 288         if (nEntries) {
 289                  AliInfo(Form("%d objects retrieved.",nEntries));
 290                  for(int i=0; i<nEntries;i++){
 291                         AliCDBEntry *entry = (AliCDBEntry*) result->At(i);
 292                         AliInfo(Form("%s",entry->GetId().ToString().Data()));
 293
 294                  }
 295         } else {
 296                  AliInfo(Form("No valid CDB object found! request was: name = <%s>, run = %d, version = %d",
 297                         (query.GetPath()).Data(), query.GetFirstRun(), query.GetVersion()));
 298         }
 299
 300         // if drain storage is set, drain entries into drain storage
 301         if((AliCDBManager::Instance())->IsDrainSet()){
 302                 for(int i = 0; i<result->GetEntries(); i++){
 303                         AliCDBEntry* entry = (AliCDBEntry*) result->At(i);
 304                         AliCDBManager::Instance()->Drain(entry);
 305                 }
 306         }
 307
 308
 309         return result;
 310 }
 311
 312 //_____________________________________________________________________________
 313 TList* AliCDBStorage::GetAll(const AliCDBPath& path, Int_t runNumber,
 314         Int_t version, Int_t subVersion) {
 315 // get multiple AliCDBEntry objects from the database
 316
 317         return GetAll(AliCDBId(path, runNumber, runNumber, version,
 318                         subVersion));
 319 }
 320
 321 //_____________________________________________________________________________
 322 TList* AliCDBStorage::GetAll(const AliCDBPath& path,
 323         const AliCDBRunRange& runRange, Int_t version, Int_t subVersion) {
 324 // get multiple AliCDBEntry objects from the database
 325
 326         return GetAll(AliCDBId(path, runRange, version, subVersion));
 327 }
 328
 329
 330 //_____________________________________________________________________________
 331 Bool_t AliCDBStorage::Put(TObject* object, AliCDBId& id, AliCDBMetaData* metaData) {
 332 // store an AliCDBEntry object into the database
 333
 334         AliCDBEntry anEntry(object, id, metaData);
 335
 336         return Put(&anEntry);
 337 }
 338
 339 //_____________________________________________________________________________
 340 Bool_t AliCDBStorage::Put(AliCDBEntry* entry) {
 341 // store an AliCDBEntry object into the database
 342
 343         if (!entry){
 344                 AliError("No entry!");
 345                 return kFALSE;
 346         }
 347
 348         if (!entry->GetId().IsValid()) {
 349                 AliError(Form("Invalid entry ID: %s",
 350                         entry->GetId().ToString().Data()));
 351                 return kFALSE;
 352         }
 353
 354         if (!entry->GetId().IsSpecified()) {
 355                 AliError(Form("Unspecified entry ID: %s",
 356                         entry->GetId().ToString().Data()));
 357                 return kFALSE;
 358         }
 359
 360         // set object's class name into metaData!
 361         entry->GetMetaData()->SetObjectClassName(entry->GetObject()->ClassName());
 362
 363         return PutEntry(entry);
 364 }
 365
 366 //_____________________________________________________________________________
 367 void AliCDBStorage::QueryCDB(Long64_t run, const char* pathFilter,
 368                                 Int_t version, AliCDBMetaData* md){
 369 // query CDB for files valid for given run, and fill list fValidFileIds
 370 // Actual query is done in virtual function QueryValidFiles()
 371
 372         fRun = run;
 373
 374         fPathFilter = pathFilter;
 375         if(!fPathFilter.IsValid()) {
 376                 AliError(Form("Filter not valid: %s", pathFilter));
 377                 fPathFilter = "*";
 378                 return;
 379         }
 380
 381         fVersion = version;
 382
 383         // Clear fValidFileIds list (it cannot be filled twice!
 384         AliDebug(2, "Clearing list of CDB Id's previously loaded");
 385         fValidFileIds.Clear();
 386
 387         if(fMetaDataFilter) {delete fMetaDataFilter; fMetaDataFilter=0;}
 388         if(md) fMetaDataFilter = dynamic_cast<AliCDBMetaData*> (md->Clone());
 389
 390         QueryValidFiles();
 391
 392         AliInfo(Form("%d files valid for run %ld, path %s and version %d found in CDB storage: \n %s://%s",
 393                                 fValidFileIds.GetEntries(), (long) fRun, pathFilter, version,
 394                                 fType.Data(), fBaseFolder.Data()));
 395
 396 }
 397
 398 //_____________________________________________________________________________
 399 void AliCDBStorage::PrintQueryCDB(){
 400 // print parameters used to load list of CDB Id's (fRun, fPathFilter, fVersion)
 401
 402         AliInfo(Form("QueryCDB Parameters: \n\tRun = %ld \n\tPath filter = %s \n\tVersion = %d",
 403                                 (long) fRun, fPathFilter.GetPath().Data(), fVersion));
 404
 405         if(fMetaDataFilter) {
 406                 AliInfo("CDBMetaData Parameters: ");
 407         }
 408         fMetaDataFilter->PrintMetaData();
 409
 410         AliInfo("Id's of valid objects found:");
 411         TIter iter(&fValidFileIds);
 412         AliCDBId* anId=0;
 413
 414         // loop on the list of selection criteria
 415         while ((anId = dynamic_cast<AliCDBId*>(iter.Next()))) {
 416                 AliInfo(Form("%s", anId->ToString().Data()));
 417         }
 418
 419 }
 420