AliAnalysisGoodies temporarily removed from the compilation
[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 TSQLServer;
29 class TMutex;
30 class TMonaLisaWriter;
31
32 class AliShuttle: public AliShuttleInterface {
33 public:
34         enum DCSType {kAlias=0, kDP};
35         enum TestMode { kNone = 0, kSkipDCS = 1, kErrorDCS = 2, kErrorFXSSources = 4, kErrorFXSFiles = 8, kErrorOCDB = 16, kErrorStorage = 32, kErrorGrid = 64 };
36
37         AliShuttle(const AliShuttleConfig* config, UInt_t timeout = 5000, Int_t retries = 5);
38         virtual ~AliShuttle();
39
40         virtual void RegisterPreprocessor(AliPreprocessor* preprocessor);
41
42         Bool_t Collect(Int_t run = -1);
43
44         Bool_t Process(AliShuttleLogbookEntry* entry);
45
46         // monitoring functions
47         ULong_t GetTimeOfLastAction() const;
48         const TString GetLastAction() const;
49
50         Int_t GetCurrentRun() const;
51         UInt_t GetCurrentStartTime() const;
52         UInt_t GetCurrentEndTime() const;
53
54         virtual Bool_t Store(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData,
55                         Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
56         virtual Bool_t StoreReferenceData(const AliCDBPath& path, TObject* object, AliCDBMetaData* metaData);
57         virtual Bool_t StoreReferenceFile(const char* detector, const char* localFile, const char* gridFileName);
58         virtual const char* GetFile(Int_t system, const char* detector,
59                 const char* id, const char* source);
60         virtual TList* GetFileSources(Int_t system, const char* detector, const char* id);
61         virtual const char* GetRunParameter(const char* lbEntry);
62         virtual AliCDBEntry* GetFromOCDB(const char* detector, const AliCDBPath& path);
63         virtual const char* GetRunType();
64         virtual void Log(const char* detector, const char* message);
65
66         void SetLogbookEntry(AliShuttleLogbookEntry* entry) {fLogbookEntry=entry;}
67         
68         void SetTestMode(TestMode testMode) { fTestMode = testMode; }
69         void SetReadTestModeFromLog(Bool_t flag) { fReadTestMode = flag; }
70
71         Bool_t Connect(Int_t system);
72
73         static void SetMainCDB (TString mainCDB) {fgkMainCDB = mainCDB;}
74         static void SetLocalCDB (TString localCDB) {fgkLocalCDB = localCDB;}
75
76         static void SetMainRefStorage (TString mainRefStorage) {fgkMainRefStorage = mainRefStorage;}
77         static void SetLocalRefStorage (TString localRefStorage) {fgkLocalRefStorage = localRefStorage;}
78
79         static void SetShuttleTempDir (const char* tmpDir);
80         static void SetShuttleLogDir (const char* logDir);
81
82 private:
83         AliShuttle(const AliShuttle& other);
84         AliShuttle& operator= (const AliShuttle& other);
85
86         Bool_t ProcessCurrentDetector();
87
88         AliShuttleLogbookEntry* QueryRunParameters(Int_t run);
89         Bool_t QueryShuttleLogbook(const char* whereClause, TObjArray& entries);
90         Bool_t RetrieveConditionsData(const TObjArray& shuttleLogbookEntries);
91
92         Bool_t GetValueSet(const char* host, Int_t port, const char* alias,
93                                 TObjArray* result, DCSType type);
94
95         Bool_t RetrieveFile(UInt_t system, const char* daqFileName, const char* localFileName);
96
97         Bool_t UpdateTable();
98         Bool_t UpdateTableFailCase();
99
100         Bool_t StoreLocally(const TString& localUri, const AliCDBPath& path, TObject* object,
101                                 AliCDBMetaData* metaData, Int_t validityStart = 0, Bool_t validityInfinite = kFALSE);
102
103         Bool_t StoreOCDB();
104         Bool_t StoreOCDB(const TString& uri);
105         Bool_t StoreRefFilesToGrid();
106         void CleanLocalStorage(const TString& uri);
107         void RemoveFile(const char* filename);
108
109         AliShuttleStatus* ReadShuttleStatus();
110         Bool_t WriteShuttleStatus(AliShuttleStatus* status);
111         Bool_t ContinueProcessing();
112         void UpdateShuttleStatus(AliShuttleStatus::Status newStatus, Bool_t increaseCount = kFALSE);
113         Bool_t UpdateShuttleLogbook(const char* detector, const char* status=0);
114         Bool_t SendMail();
115         
116         TString GetLogFileName(const char* detector) const;
117
118         void SetLastAction(const char* action);
119         
120         void SendMLInfo();
121
122         const AliShuttleConfig* fConfig;        // pointer to configuration object
123
124         UInt_t fTimeout;        // DCS server connection timeout parameter
125         Int_t fRetries;         // Number of DCS server connection retries
126
127         TMap fPreprocessorMap;  // list of detector Preprocessors ("DET", "Preprocessor")
128
129         AliShuttleLogbookEntry* fLogbookEntry;   //! current Shuttle logbook entry
130         TString fCurrentDetector; // current detector
131
132         TSQLServer *fServer[4];         // pointer to the three FXS + Run & Shuttle logbook servers
133         Bool_t fFXSCalled[3];           // FXS call status
134         TList  fFXSlist[3];             // List of files retrieved from each FXS
135
136         AliCDBEntry* fStatusEntry; // last CDB entry containing a AliShuttleStatus retrieved
137
138         TMutex* fMonitoringMutex;   // mutex to lock the monitoring class members
139         UInt_t fLastActionTime;    // time of last action for monitoring
140         TString fLastAction;       // string description for last action
141
142         Bool_t fFirstUnprocessed[AliShuttleInterface::kNDetectors];       // array of flags for first unprocessed dets
143
144         TMonaLisaWriter* fMonaLisa;  // ML instance that sends the processing information
145
146         TestMode fTestMode;          // sets test mode flags, that e.g. simulate a dcs error etc.
147         Bool_t fReadTestMode;        // Reads the test mode from the log entry of the given run (only for test)
148         
149         Bool_t fOutputRedirected;    // is the output redirected to a file
150
151         ClassDef(AliShuttle, 0);
152 };
153
154 #endif