MetalinkParserStateMachine.h 7.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
/* <!-- copyright */
/*
 * aria2 - The high speed download utility
 *
 * Copyright (C) 2006 Tatsuhiro Tsujikawa
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
 */
/* copyright --> */
#ifndef D_METALINK_PARSER_STATE_MACHINE_H
#define D_METALINK_PARSER_STATE_MACHINE_H

#include "ParserStateMachine.h"

#include <string>
#include <vector>
#include <stack>
43
#include <memory>
44 45 46 47 48 49 50 51 52 53

#include "MetalinkParserController.h"
#include "MetalinkParserState.h"

namespace aria2 {

class Metalinker;

class MetalinkParserStateMachine : public ParserStateMachine {
private:
54
  std::unique_ptr<MetalinkParserController> ctrl_;
55 56 57 58 59 60 61 62

  std::stack<MetalinkParserState*> stateStack_;

  // Error messages encountered while parsing document.
  std::vector<std::string> errors_;

  static MetalinkParserState* initialState_;
  static MetalinkParserState* skipTagState_;
63

64 65 66 67 68 69 70 71 72 73
  // Metalink3
  static MetalinkParserState* metalinkState_;
  static MetalinkParserState* filesState_; // Metalink3Spec
  static MetalinkParserState* fileState_;
  static MetalinkParserState* sizeState_;
  static MetalinkParserState* versionState_;
  static MetalinkParserState* languageState_;
  static MetalinkParserState* osState_;
  static MetalinkParserState* verificationState_; // Metalink3Spec
  static MetalinkParserState* hashState_;
74
  static MetalinkParserState* piecesState_;    // Metalink3Spec
75 76 77 78 79 80 81 82 83 84 85 86 87
  static MetalinkParserState* pieceHashState_; // Metalink3Spec
  static MetalinkParserState* signatureState_;
  static MetalinkParserState* resourcesState_; // Metalink3Spec
  static MetalinkParserState* urlState_;

  // Metalink4
  static MetalinkParserState* metalinkStateV4_;
  static MetalinkParserState* fileStateV4_;
  static MetalinkParserState* sizeStateV4_;
  static MetalinkParserState* versionStateV4_;
  static MetalinkParserState* languageStateV4_;
  static MetalinkParserState* osStateV4_;
  static MetalinkParserState* hashStateV4_;
88
  static MetalinkParserState* piecesStateV4_;    // Metalink4Spec
89 90 91 92
  static MetalinkParserState* pieceHashStateV4_; // Metalink4Spec
  static MetalinkParserState* signatureStateV4_;
  static MetalinkParserState* urlStateV4_;
  static MetalinkParserState* metaurlStateV4_;
93

94 95 96 97 98
public:
  MetalinkParserStateMachine();

  virtual ~MetalinkParserStateMachine();

99
  virtual bool needsCharactersBuffering() const CXX11_OVERRIDE;
100

101
  virtual bool finished() const CXX11_OVERRIDE;
102

103 104 105
  virtual void beginElement(const char* localname, const char* prefix,
                            const char* nsUri,
                            const std::vector<XmlAttr>& attrs) CXX11_OVERRIDE;
106

107 108 109
  virtual void endElement(const char* localname, const char* prefix,
                          const char* nsUri,
                          std::string characters) CXX11_OVERRIDE;
110

111
  virtual void reset() CXX11_OVERRIDE;
112

113 114 115 116 117 118 119 120 121 122 123 124 125
  void setSkipTagState();

  void setMetalinkState();

  void setFilesState(); // Metalink3Spec

  void setFileState();

  void setSizeState();

  void setVersionState();

  void setLanguageState();
126

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
  void setOSState();

  void setVerificationState(); // Metalink3Spec

  void setHashState();

  void setPiecesState(); // Metalink3Spec

  void setPieceHashState(); // Metalink3Spec

  void setSignatureState();

  void setResourcesState(); // Metalink3Spec

  void setURLState();

  // Metalink4
  void setMetalinkStateV4();
  void setFileStateV4();
  void setSizeStateV4();
  void setVersionStateV4();
  void setLanguageStateV4();
  void setOSStateV4();
  void setHashStateV4();
151
  void setPiecesStateV4();    // Metalink4Spec
152 153 154 155 156 157 158
  void setPieceHashStateV4(); // Metalink4Spec
  void setSignatureStateV4();
  void setURLStateV4();
  void setMetaurlStateV4();

  void newEntryTransaction();

159
  void setFileNameOfEntry(std::string filename);
160

161
  void setFileLengthOfEntry(int64_t length);
162

163
  void setVersionOfEntry(std::string version);
164

165
  void setLanguageOfEntry(std::string language);
166

167
  void setOSOfEntry(std::string os);
168 169 170 171 172 173 174 175 176

  void setMaxConnectionsOfEntry(int maxConnections); // Metalink3Spec

  void commitEntryTransaction();

  void cancelEntryTransaction();

  void newResourceTransaction();

177
  void setURLOfResource(std::string url);
178

179
  void setTypeOfResource(std::string type);
180

181
  void setLocationOfResource(std::string location);
182 183 184 185 186 187 188 189 190 191 192

  void setPriorityOfResource(int priority);

  void setMaxConnectionsOfResource(int maxConnections); // Metalink3Spec

  void commitResourceTransaction();

  void cancelResourceTransaction();

  void newChecksumTransaction();

193
  void setTypeOfChecksum(std::string type);
194

195
  void setHashOfChecksum(std::string md);
196 197 198 199 200 201 202 203 204

  void commitChecksumTransaction();

  void cancelChecksumTransaction();

  void newChunkChecksumTransactionV4(); // Metalink4Spec

  void setLengthOfChunkChecksumV4(size_t length); // Metalink4Spec

205
  void setTypeOfChunkChecksumV4(std::string type); // Metalink4Spec
206

207
  void addHashOfChunkChecksumV4(std::string md); // Metalink4Spec
208 209 210 211 212 213 214 215 216

  void commitChunkChecksumTransactionV4(); // Metalink4Spec

  void cancelChunkChecksumTransactionV4(); // Metalink4Spec

  void newChunkChecksumTransaction(); // Metalink3Spec

  void setLengthOfChunkChecksum(size_t length); // Metalink3Spec

217
  void setTypeOfChunkChecksum(std::string type); // Metalink3Spec
218 219 220

  void createNewHashOfChunkChecksum(size_t order); // Metalink3Spec

221
  void setMessageDigestOfChunkChecksum(std::string md); // Metalink3Spec
222 223 224 225 226 227 228 229 230

  void addHashOfChunkChecksum(); // Metalink3Spec

  void commitChunkChecksumTransaction(); // Metalink3Spec

  void cancelChunkChecksumTransaction(); // Metalink3Spec

  void newSignatureTransaction();

231
  void setTypeOfSignature(std::string type);
232

233
  void setFileOfSignature(std::string file);
234

235
  void setBodyOfSignature(std::string body);
236 237 238 239 240 241 242

  void commitSignatureTransaction();

  void cancelSignatureTransaction();

  void newMetaurlTransaction();

243
  void setURLOfMetaurl(std::string url);
244

245
  void setMediatypeOfMetaurl(std::string mediatype);
246 247 248

  void setPriorityOfMetaurl(int priority);

249
  void setNameOfMetaurl(std::string name);
250 251 252 253 254 255

  void commitMetaurlTransaction();

  void cancelMetaurlTransaction();

  // Only stores first 10 errors.
256
  void logError(std::string log);
257

258
  const std::vector<std::string>& getErrors() const { return errors_; }
259 260 261

  std::string getErrorString() const;

262
  std::unique_ptr<Metalinker> getResult();
263

264
  void setBaseUri(std::string uri);
265 266 267 268 269
};

} //  namespace aria2

#endif // D_METALINK_PARSER_STATE_MACHINE_H