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