introducing strict run ordering flag
[u/mrichter/AliRoot.git] / SHUTTLE / AliShuttle.h
1 #ifndef ALI_SHUTTLE_H
2 #define ALI_SHUTTLE_H
3
4 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
5  * See cxx source for full Copyright notice                               */
6
7 /* $Id$ */
8
9
10 //
11 // This class is the main manager for 
12 // AliShuttle. It organizes the data retrieval
13 // from DCS and call the interface methods of
14 // AliPreprocessor.
15 //
16
17 #include <TMap.h>
18 #include <TString.h>
19 #include <TList.h>
20
21 #include "AliShuttleInterface.h"
22 #include "AliShuttleStatus.h"
23
24 class TObject;
25 class AliShuttleConfig;
26 class AliShuttleLogbookEntry;
27 class AliPreprocessor;
28 class AliCDBMetaData;
29 class TSQLServer;
30 class AliCDBEntry;
31 class AliCDBPath;
32 class TMutex;
33
34 class AliShuttle: public AliShuttleInterface {
35 public:
36         AliShuttle(const AliShuttleConfig* config, UInt_t timeout = 5000, Int_t retries = 5);
37         virtual ~AliShuttle();
38
39         virtual void RegisterPreprocessor(AliPreprocessor* preprocessor);
40
41         Bool_t Collect(Int_t run = -1);
42
43         Bool_t Process(AliShuttleLogbookEntry* entry);
44
45         // monitoring functions
46         ULong_t GetTimeOfLastAction() const;
47         const TString GetLastAction() const;
48
49         Int_t GetCurrentRun() const;
50         UInt_t GetCurrentStartTime() const;
51         UInt_t GetCurrentEndTime() const;
52
53         virtual UInt_t Store(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
54                         Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
55         virtual UInt_t StoreReferenceData(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData);
56         virtual const char* GetFile(Int_t system, const char* detector,
57                 const char* id, const char* source);
58         virtual TList* GetFileSources(Int_t system, const char* detector, const char* id);
59         virtual const char* GetRunParameter(const char* lbEntry);
60         virtual void Log(const char* detector, const char* message);
61
62         static TString GetMainCDB () {return fgkMainCDB;}
63         static void SetMainCDB (TString mainCDB) {fgkMainCDB = mainCDB;}
64         static TString GetLocalCDB () {return fgkLocalCDB;}
65         static void SetLocalCDB (TString localCDB) {fgkLocalCDB = localCDB;}
66
67         static TString GetMainRefStorage() {return fgkMainRefStorage;}
68         static void SetMainRefStorage (TString mainRefStorage) {fgkMainRefStorage = mainRefStorage;}
69         static TString GetLocalRefStorage() {return fgkLocalRefStorage;}
70         static void SetLocalRefStorage (TString localRefStorage) {fgkLocalRefStorage = localRefStorage;}
71
72         //TODO Test only, remove later !
73         void SetProcessDCS(Bool_t process) {fgkProcessDCS = process;}
74         void SetLogbookEntry(AliShuttleLogbookEntry* entry) {fLogbookEntry=entry;}
75
76         static const char* GetShuttleTempDir() {return fgkShuttleTempDir;}
77
78         Bool_t Connect(Int_t system);
79
80 private:
81         AliShuttle(const AliShuttle& other);
82         AliShuttle& operator= (const AliShuttle& other);
83
84         UInt_t ProcessCurrentDetector();
85
86         AliShuttleLogbookEntry* QueryRunParameters(Int_t run);
87         Bool_t QueryShuttleLogbook(const char* whereClause, TObjArray& entries);
88         Bool_t RetrieveConditionsData(const TObjArray& shuttleLogbookEntries);
89
90         Bool_t GetValueSet(const char* host, Int_t port, const char* alias, TObjArray* result);
91
92         const char* GetDAQFileName(const char* detector, const char* id, const char* source);
93         Bool_t RetrieveDAQFile(const char* daqFileName, const char* localFileName);
94         TList* GetDAQFileSources(const char* detector, const char* id);
95         Bool_t UpdateDAQTable();
96
97         const char* GetDCSFileName(const char* detector, const char* id, const char* source);
98 //      Bool_t RetrieveDCSFile(const char* daqFileName const char* localFileName);
99         TList* GetDCSFileSources(const char* detector, const char* id);
100
101         const char* GetHLTFileName(const char* detector, const char* id, const char* source);
102 //      Bool_t RetrieveHLTFile(const char* daqFileName, const char* localFileName;
103         TList* GetHLTFileSources(const char* detector, const char* id);
104
105         UInt_t WriteToCDB(const char* mainUri, const char* localUri,
106                                 const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
107                                 Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
108
109         Bool_t TryToStoreAgain();
110         Bool_t TryToStoreAgain(TString& storageType);
111
112         AliShuttleStatus* ReadShuttleStatus();
113         Bool_t WriteShuttleStatus(AliShuttleStatus* status);
114         Bool_t ContinueProcessing();
115         void UpdateShuttleStatus(AliShuttleStatus::Status newStatus, Bool_t increaseCount = kFALSE);
116         Bool_t UpdateShuttleLogbook(const char* detector, const char* status=0);
117         
118         void SetLastAction(const char* action);
119
120         const AliShuttleConfig* fConfig;        // pointer to configuration object
121
122         static TString      fgkMainCDB;         // URI of the main (Grid) CDB storage
123         static TString      fgkLocalCDB;                //! URI of the local backup CDB storage
124         static TString      fgkMainRefStorage;  // URI of the main (Grid) REFERENCE storage
125         static TString      fgkLocalRefStorage; // URI of the local REFERENCE storage
126         static const char*  fgkShuttleTempDir;  // base path of SHUTTLE temp folder
127         static const char*  fgkShuttleLogDir;   // path of SHUTTLE log folder
128
129         UInt_t fTimeout;        // DCS server connection timeout parameter
130         Int_t fRetries;         // Number of DCS server connection retries
131
132         TMap fPreprocessorMap;  // list of detector Preprocessors ("DET", "Preprocessor")
133
134         AliShuttleLogbookEntry* fLogbookEntry;   //! current Shuttle logbook entry
135         TString fCurrentDetector; // current detector
136
137         TSQLServer *fServer[4];         // pointer to the three FES + Run & Shuttle logbook servers
138         Bool_t fFESCalled[3];           // FES call status
139         TList  fFESlist[3];             // List of files retrieved from each FES
140
141         AliCDBEntry* fStatusEntry; // last CDB entry containing a AliShuttleStatus retrieved
142         Bool_t fGridError;         // Grid storage error flag
143
144         TMutex* fMonitoringMutex;   // mutex to lock the monitoring class members
145         UInt_t fLastActionTime;    // time of last action for monitoring
146         TString fLastAction;       // string description for last action
147
148         Bool_t fFirstUnprocessed[AliShuttleInterface::kNDetectors];       // array of flags for first unprocessed dets
149
150         //TODO Test only, remove later !
151         static Bool_t fgkProcessDCS; // flag to enable DCS archive data processing
152
153         ClassDef(AliShuttle, 0);
154 };
155
156 #endif