Bug fix
[u/mrichter/AliRoot.git] / STEER / AliCDBStorage.cxx
CommitLineData
2c8628dd 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
b05400be 16#include <TKey.h>
02c4845e 17#include <TH1.h>
145f45a2 18#include <TTree.h>
ed343d5e 19#include <TNtuple.h>
145f45a2 20#include <TFile.h>
fe913d8f 21#include "AliCDBStorage.h"
b8ec52f6 22#include "AliCDBGrid.h"
2c8628dd 23
9e1ceb13 24#include "AliCDBEntry.h"
25#include "AliLog.h"
2c8628dd 26
fe913d8f 27ClassImp(AliCDBStorage)
2c8628dd 28
9e1ceb13 29//_____________________________________________________________________________
62032124 30AliCDBStorage::AliCDBStorage():
31fValidFileIds(),
32fRun(-1),
33fPathFilter(),
34fVersion(-1),
35fMetaDataFilter(0),
36fSelections(),
37fURI(),
38fType(),
39fBaseFolder()
40{
9e1ceb13 41// constructor
42
62032124 43 fValidFileIds.SetOwner(1);
9e1ceb13 44 fSelections.SetOwner(1);
45}
2c8628dd 46
9e1ceb13 47//_____________________________________________________________________________
48AliCDBStorage::~AliCDBStorage() {
49// destructor
2c8628dd 50
62032124 51 RemoveAllSelections();
52 fValidFileIds.Clear();
53 delete fMetaDataFilter;
54
9e1ceb13 55}
2c8628dd 56
57//_____________________________________________________________________________
4b5e0dce 58void AliCDBStorage::GetSelection(/*const*/ AliCDBId* id) {
0f678e35 59// return required version and subversion from the list of selection criteria
9e1ceb13 60
61 TIter iter(&fSelections);
62 AliCDBId* aSelection;
63
64 // loop on the list of selection criteria
65 while ((aSelection = (AliCDBId*) iter.Next())) {
66 // check if selection element contains id's path and run (range)
4b5e0dce 67 if (aSelection->Comprises(*id)) {
b05400be 68 AliDebug(2,Form("Using selection criterion: %s ", aSelection->ToString().Data()));
9e1ceb13 69 // return required version and subversion
4b5e0dce 70
71 id->SetVersion(aSelection->GetVersion());
72 id->SetSubVersion(aSelection->GetSubVersion());
73 return;
9e1ceb13 74 }
75 }
76
77 // no valid element is found in the list of selection criteria -> return
b05400be 78 AliDebug(2,"Looking for objects with most recent version");
4b5e0dce 79 return;
2c8628dd 80}
81
b05400be 82//_____________________________________________________________________________
83void AliCDBStorage::ReadSelectionFromFile(const char *fileName){
84// read selection criteria list from file
85
86 RemoveAllSelections();
87
88 TList *list = GetIdListFromFile(fileName);
89 if(!list) return;
90
91 list->SetOwner();
92 Int_t nId = list->GetEntries();
93 AliCDBId *id;
94 TKey *key;
95
96 for(int i=nId-1;i>=0;i--){
97 key = (TKey*) list->At(i);
98 id = (AliCDBId*) key->ReadObj();
99 if(id) AddSelection(*id);
100 }
101 delete list;
102 AliInfo(Form("Selection criteria list filled with %d entries",fSelections.GetEntries()));
103 PrintSelectionList();
104
105}
106
2c8628dd 107//_____________________________________________________________________________
9e1ceb13 108void AliCDBStorage::AddSelection(const AliCDBId& selection) {
109// add a selection criterion
110
111 AliCDBPath path = selection.GetPath();
112 if(!path.IsValid()) return;
113
114 TIter iter(&fSelections);
115 const AliCDBId *anId;
116 while((anId = (AliCDBId*) iter.Next())){
117 if(selection.Comprises(*anId)){
118 AliWarning("This selection is more general than a previous one and will hide it!");
119 AliWarning(Form("%s", (anId->ToString()).Data()));
120 fSelections.AddBefore(anId, new AliCDBId(selection));
121 return;
122 }
123
124 }
125 fSelections.AddFirst(new AliCDBId(selection));
126}
2c8628dd 127
128//_____________________________________________________________________________
62032124 129void AliCDBStorage::AddSelection(const AliCDBPath& path,
9e1ceb13 130 const AliCDBRunRange& runRange, Int_t version, Int_t subVersion){
131// add a selection criterion
2c8628dd 132
9e1ceb13 133 AddSelection(AliCDBId(path, runRange, version, subVersion));
2c8628dd 134}
135
9e1ceb13 136//_____________________________________________________________________________
137void AliCDBStorage::AddSelection(const AliCDBPath& path,
138 Int_t firstRun, Int_t lastRun, Int_t version, Int_t subVersion){
139// add a selection criterion
140
141 AddSelection(AliCDBId(path, firstRun, lastRun, version, subVersion));
142}
2c8628dd 143
9e1ceb13 144//_____________________________________________________________________________
145void AliCDBStorage::RemoveSelection(const AliCDBId& selection) {
146// remove a selection criterion
2c8628dd 147
9e1ceb13 148 TIter iter(&fSelections);
149 AliCDBId* aSelection;
2c8628dd 150
9e1ceb13 151 while ((aSelection = (AliCDBId*) iter.Next())) {
152 if (selection.Comprises(*aSelection)) {
153 fSelections.Remove(aSelection);
154 }
155 }
156}
2c8628dd 157
9e1ceb13 158//_____________________________________________________________________________
159void AliCDBStorage::RemoveSelection(const AliCDBPath& path,
160 const AliCDBRunRange& runRange){
161// remove a selection criterion
2c8628dd 162
9e1ceb13 163 RemoveSelection(AliCDBId(path, runRange, -1, -1));
164}
f05209ee 165
9e1ceb13 166//_____________________________________________________________________________
167void AliCDBStorage::RemoveSelection(const AliCDBPath& path,
168 Int_t firstRun, Int_t lastRun){
169// remove a selection criterion
f05209ee 170
9e1ceb13 171 RemoveSelection(AliCDBId(path, firstRun, lastRun, -1, -1));
172}
f05209ee 173
9e1ceb13 174//_____________________________________________________________________________
eb0b1051 175void AliCDBStorage::RemoveSelection(int position){
9e1ceb13 176// remove a selection criterion from its position in the list
2c8628dd 177
62032124 178 delete fSelections.RemoveAt(position);
2c8628dd 179}
180
2c8628dd 181//_____________________________________________________________________________
9e1ceb13 182void AliCDBStorage::RemoveAllSelections(){
183// remove all selection criteria
2c8628dd 184
62032124 185 fSelections.Clear();
9e1ceb13 186}
fe913d8f 187
9e1ceb13 188//_____________________________________________________________________________
189void AliCDBStorage::PrintSelectionList(){
190// prints the list of selection criteria
191
192 TIter iter(&fSelections);
193 AliCDBId* aSelection;
62032124 194
9e1ceb13 195 // loop on the list of selection criteria
196 int index=0;
197 while ((aSelection = (AliCDBId*) iter.Next())) {
198 AliInfo(Form("index %d -> selection: %s",index++, aSelection->ToString().Data()));
199 }
fe913d8f 200
9e1ceb13 201}
fe913d8f 202
9e1ceb13 203//_____________________________________________________________________________
0f678e35 204AliCDBEntry* AliCDBStorage::Get(const AliCDBId& query) {
9e1ceb13 205// get an AliCDBEntry object from the database
206
207 // check if query's path and runRange are valid
208 // query is invalid also if version is not specified and subversion is!
209 if (!query.IsValid()) {
210 AliError(Form("Invalid query: %s", query.ToString().Data()));
211 return NULL;
212 }
213
214 // query is not specified if path contains wildcard or runrange = [-1,-1]
215 if (!query.IsSpecified()) {
216 AliError(Form("Unspecified query: %s",
217 query.ToString().Data()));
218 return NULL;
219 }
62032124 220
02c4845e 221 // This is needed otherwise TH1 objects (histos, TTree's) are lost when file is closed!
222 Bool_t oldStatus = TH1::AddDirectoryStatus();
223 TH1::AddDirectory(kFALSE);
9e1ceb13 224
225 AliCDBEntry* entry = GetEntry(query);
02c4845e 226
227 if (oldStatus != kFALSE)
228 TH1::AddDirectory(kTRUE);
0f678e35 229
9e1ceb13 230 if (entry) {
62032124 231 // this is to make the SHUTTLE output lighter
232 if(!(query.GetPath().Contains("SHUTTLE/STATUS")))
b8ec52f6 233 AliDebug(2, Form("CDB object retrieved: %s", entry->GetId().ToString().Data()));
9e1ceb13 234 } else {
62032124 235 // this is to make the SHUTTLE output lighter
0f678e35 236 if(!(query.GetPath().Contains("SHUTTLE/STATUS")))
c3a7b59a 237 AliInfo(Form("No valid CDB object found! request was: %s", query.ToString().Data()));
9e1ceb13 238 }
0f678e35 239
9e1ceb13 240 // if drain storage is set, drain entry into drain storage
241 if(entry && (AliCDBManager::Instance())->IsDrainSet())
242 AliCDBManager::Instance()->Drain(entry);
0f678e35 243
9e1ceb13 244 return entry;
2c8628dd 245}
246
247//_____________________________________________________________________________
9e1ceb13 248AliCDBEntry* AliCDBStorage::Get(const AliCDBPath& path, Int_t runNumber,
249 Int_t version, Int_t subVersion) {
250// get an AliCDBEntry object from the database
2c8628dd 251
9e1ceb13 252 return Get(AliCDBId(path, runNumber, runNumber, version, subVersion));
2c8628dd 253}
254
2c8628dd 255//_____________________________________________________________________________
9e1ceb13 256AliCDBEntry* AliCDBStorage::Get(const AliCDBPath& path,
257 const AliCDBRunRange& runRange, Int_t version,
258 Int_t subVersion) {
259// get an AliCDBEntry object from the database
2c8628dd 260
9e1ceb13 261 return Get(AliCDBId(path, runRange, version, subVersion));
2c8628dd 262}
263
2c8628dd 264//_____________________________________________________________________________
9e1ceb13 265TList* AliCDBStorage::GetAll(const AliCDBId& query) {
266// get multiple AliCDBEntry objects from the database
267
268
269 if (!query.IsValid()) {
270 AliError(Form("Invalid query: %s", query.ToString().Data()));
271 return NULL;
272 }
273
274 if (query.IsAnyRange()) {
275 AliError(Form("Unspecified run or runrange: %s",
276 query.ToString().Data()));
277 return NULL;
278 }
279
02c4845e 280 // This is needed otherwise TH1 objects (histos, TTree's) are lost when file is closed!
281 Bool_t oldStatus = TH1::AddDirectoryStatus();
282 TH1::AddDirectory(kFALSE);
283
9e1ceb13 284 TList *result = GetEntries(query);
285
02c4845e 286 if (oldStatus != kFALSE)
287 TH1::AddDirectory(kTRUE);
288
9e1ceb13 289 Int_t nEntries = result->GetEntries();
b8ec52f6 290
291 AliInfo(Form("%d objects retrieved. Request was: %s",
292 nEntries, query.ToString().Data()));
293 for(int i=0; i<nEntries;i++){
294 AliCDBEntry *entry = (AliCDBEntry*) result->At(i);
295 AliInfo(Form("%s",entry->GetId().ToString().Data()));
9e1ceb13 296 }
297
b8ec52f6 298
9e1ceb13 299 // if drain storage is set, drain entries into drain storage
300 if((AliCDBManager::Instance())->IsDrainSet()){
301 for(int i = 0; i<result->GetEntries(); i++){
302 AliCDBEntry* entry = (AliCDBEntry*) result->At(i);
303 AliCDBManager::Instance()->Drain(entry);
304 }
305 }
306
307
308 return result;
309}
2c8628dd 310
9e1ceb13 311//_____________________________________________________________________________
312TList* AliCDBStorage::GetAll(const AliCDBPath& path, Int_t runNumber,
313 Int_t version, Int_t subVersion) {
314// get multiple AliCDBEntry objects from the database
2c8628dd 315
9e1ceb13 316 return GetAll(AliCDBId(path, runNumber, runNumber, version,
317 subVersion));
2c8628dd 318}
319
2c8628dd 320//_____________________________________________________________________________
9e1ceb13 321TList* AliCDBStorage::GetAll(const AliCDBPath& path,
322 const AliCDBRunRange& runRange, Int_t version, Int_t subVersion) {
323// get multiple AliCDBEntry objects from the database
2c8628dd 324
9e1ceb13 325 return GetAll(AliCDBId(path, runRange, version, subVersion));
2c8628dd 326}
f05209ee 327
328
329//_____________________________________________________________________________
b8ec52f6 330Bool_t AliCDBStorage::Put(TObject* object, AliCDBId& id, AliCDBMetaData* metaData, AliCDBManager::DataType type) {
02c4845e 331// store an AliCDBEntry object into the database
9e1ceb13 332
333 AliCDBEntry anEntry(object, id, metaData);
f05209ee 334
b8ec52f6 335 return Put(&anEntry, type);
336}
f05209ee 337
9e1ceb13 338//_____________________________________________________________________________
b8ec52f6 339Bool_t AliCDBStorage::Put(AliCDBEntry* entry, AliCDBManager::DataType type) {
02c4845e 340// store an AliCDBEntry object into the database
9e1ceb13 341
02c4845e 342 if (!entry){
343 AliError("No entry!");
344 return kFALSE;
345 }
346
9e1ceb13 347 if (!entry->GetId().IsValid()) {
62032124 348 AliError(Form("Invalid entry ID: %s",
9e1ceb13 349 entry->GetId().ToString().Data()));
350 return kFALSE;
351 }
352
353 if (!entry->GetId().IsSpecified()) {
62032124 354 AliError(Form("Unspecified entry ID: %s",
9e1ceb13 355 entry->GetId().ToString().Data()));
356 return kFALSE;
357 }
358
b8ec52f6 359 AliCDBManager::DataType expectedType = GetDataType();
360
361 if(expectedType != AliCDBManager::kPrivate && type != expectedType) {
362 AliError(Form("It is forbidden to store %s data into a folder of type %s!",
363 AliCDBManager::GetDataTypeName(type),
364 AliCDBManager::GetDataTypeName(expectedType)));
365 return 0;
366 }
367
02c4845e 368 // set object's class name into metaData!
369 entry->GetMetaData()->SetObjectClassName(entry->GetObject()->ClassName());
370
9e1ceb13 371 return PutEntry(entry);
f05209ee 372}
fe913d8f 373
62032124 374//_____________________________________________________________________________
c3a7b59a 375void AliCDBStorage::QueryCDB(Int_t run, const char* pathFilter,
62032124 376 Int_t version, AliCDBMetaData* md){
377// query CDB for files valid for given run, and fill list fValidFileIds
378// Actual query is done in virtual function QueryValidFiles()
379
380 fRun = run;
381
382 fPathFilter = pathFilter;
383 if(!fPathFilter.IsValid()) {
384 AliError(Form("Filter not valid: %s", pathFilter));
385 fPathFilter = "*";
386 return;
387 }
388
389 fVersion = version;
390
6dc56e97 391 AliInfo(Form("Querying files valid for run %d and path \"%s\" into CDB storage \"%s://%s\"",
392 fRun, pathFilter, fType.Data(), fBaseFolder.Data()));
393
62032124 394 // Clear fValidFileIds list (it cannot be filled twice!
395 AliDebug(2, "Clearing list of CDB Id's previously loaded");
396 fValidFileIds.Clear();
397
398 if(fMetaDataFilter) {delete fMetaDataFilter; fMetaDataFilter=0;}
399 if(md) fMetaDataFilter = dynamic_cast<AliCDBMetaData*> (md->Clone());
400
401 QueryValidFiles();
c3a7b59a 402 AliCDBId queryId(pathFilter,run,run,version);
62032124 403
6dc56e97 404 AliInfo(Form("%d valid files found!", fValidFileIds.GetEntriesFast()));
62032124 405
406}
407
408//_____________________________________________________________________________
409void AliCDBStorage::PrintQueryCDB(){
410// print parameters used to load list of CDB Id's (fRun, fPathFilter, fVersion)
411
c3a7b59a 412 AliCDBId paramId(fPathFilter, fRun, fRun, fVersion);
413 AliInfo(Form("**** QueryCDB Parameters **** \n\t<%s>\n",
414 paramId.ToString().Data()));
415
416 if(fMetaDataFilter) fMetaDataFilter->PrintMetaData();
62032124 417
62032124 418
c3a7b59a 419 TString message = "**** Id's of valid objects found *****\n";
62032124 420 TIter iter(&fValidFileIds);
421 AliCDBId* anId=0;
422
423 // loop on the list of selection criteria
424 while ((anId = dynamic_cast<AliCDBId*>(iter.Next()))) {
c3a7b59a 425 message += Form("\t%s\n", anId->ToString().Data());
62032124 426 }
6dc56e97 427 message += Form("\n\tTotal: %d objects found\n", fValidFileIds.GetEntriesFast());
c3a7b59a 428 AliInfo(Form("%s", message.Data()));
62032124 429}
430
b8ec52f6 431//_____________________________________________________________________________
432AliCDBManager::DataType AliCDBStorage::GetDataType() const {
433// returns the type of the data that should be stored into this storage:
434// kConditions: conditions data; kReference: reference data; kPrivate: private (user-defined) data type
435
436 if(GetType() != "alien") return AliCDBManager::kPrivate;
437
438 TString condFolder = ((AliCDBGridParam*) AliCDBManager::Instance()->GetCondParam())->GetDBFolder();
439 TString refFolder = ((AliCDBGridParam*) AliCDBManager::Instance()->GetRefParam())->GetDBFolder();
440
441 if(GetBaseFolder().Contains(condFolder)) return AliCDBManager::kCondition;
442 if(GetBaseFolder().Contains(refFolder)) return AliCDBManager::kReference;
443
444 return AliCDBManager::kPrivate;
445}
145f45a2 446
447//_____________________________________________________________________________
448void AliCDBStorage::LoadTreeFromFile(AliCDBEntry *entry) const {
449// Checks whether entry contains a TTree and in case loads it into memory
450
ed343d5e 451 TObject *obj = (TObject*) entry->GetObject();
145f45a2 452
ed343d5e 453 if (!strcmp(obj->ClassName(),TTree::Class_Name())) {
145f45a2 454
ed343d5e 455 AliWarning("Entry contains a TTree! Loading baskets...");
145f45a2 456
ed343d5e 457 TTree* tree = dynamic_cast<TTree*> (obj);
145f45a2 458
ed343d5e 459 if(!tree) return;
145f45a2 460
ed343d5e 461 tree->LoadBaskets();
462 tree->SetDirectory(0);
463 }
464 else if (!strcmp(obj->ClassName(),TNtuple::Class_Name())){
145f45a2 465
ed343d5e 466 AliWarning("Entry contains a TNtuple! Loading baskets...");
145f45a2 467
ed343d5e 468 TNtuple* ntu = dynamic_cast<TNtuple*> (obj);
145f45a2 469
ed343d5e 470 if(!ntu) return;
145f45a2 471
ed343d5e 472 ntu->LoadBaskets();
473 ntu->SetDirectory(0);
474 }
145f45a2 475
476 return;
477}
ed343d5e 478
479// //_____________________________________________________________________________
480// void AliCDBStorage::SetTreeToFile(AliCDBEntry *entry, TFile* file) const {
481// // Checks whether entry contains a TTree and in case assigns it to memory
482//
483// AliCDBMetaData *md = dynamic_cast<AliCDBMetaData*> (entry->GetMetaData());
484// if(!md) return;
485// TString objStr = md->GetObjectClassName();
486// if(objStr != "TTree") return;
487// AliWarning("Entry contains a TTree! Setting file...");
488//
489// TTree* tree = dynamic_cast<TTree*> (entry->GetObject());
490//
491// if(!tree) return;
492//
493// // tree->SetDirectory(file);
494// tree->SetDirectory(0);
495//
496// return;
497// }