1 // Copyright 2012 The Chromium Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 #ifndef SYNC_API_SYNC_ERROR_H_ 6 #define SYNC_API_SYNC_ERROR_H_ 7 8 #include <iosfwd> 9 #include <string> 10 11 #include "base/memory/scoped_ptr.h" 12 #include "sync/base/sync_export.h" 13 #include "sync/internal_api/public/base/model_type.h" 14 15 namespace tracked_objects { 16 class Location; 17 } // namespace tracked_objects 18 19 namespace syncer { 20 21 // Sync errors are used for debug purposes and handled internally and/or 22 // exposed through Chrome's "about:sync" internal page. 23 // This class is copy-friendly and thread-safe. 24 class SYNC_EXPORT SyncError { 25 public: 26 // Error types are used to distinguish general datatype errors (which result 27 // in the datatype being disabled) from actionable sync errors (which might 28 // have more complicated results). 29 enum ErrorType { 30 UNSET, // No error. 31 UNRECOVERABLE_ERROR, // An unrecoverable runtime error was encountered, and 32 // sync should be disabled and purged completely. 33 DATATYPE_ERROR, // A datatype error was encountered, and the datatype 34 // should be disabled and purged completely. Note that 35 // datatype errors may be reset, triggering a 36 // re-enable. 37 PERSISTENCE_ERROR, // A persistence error was detected, and the 38 // datataype should be associated after a sync update. 39 CRYPTO_ERROR, // A cryptographer error was detected, and the 40 // datatype should be associated after it is resolved. 41 UNREADY_ERROR, // A datatype is not ready to start yet, so should be 42 // neither purged nor enabled until it is ready. 43 DATATYPE_POLICY_ERROR // A datatype should be disabled and purged due 44 // to configuration constraints. 45 }; 46 47 // Severity is used to indicate how an error should be logged and 48 // represented to an end user. 49 enum Severity { 50 SYNC_ERROR_SEVERITY_ERROR, // Severe unrecoverable error. 51 SYNC_ERROR_SEVERITY_INFO // Low-severity recoverable error or 52 // configuration policy issue. 53 }; 54 55 // Default constructor refers to "no error", and IsSet() will return false. 56 SyncError(); 57 58 // Create a new Sync error of type |error_type| triggered by |model_type| 59 // from the specified location. IsSet() will return true afterward. Will 60 // create and print an error specific message to LOG(ERROR). 61 SyncError(const tracked_objects::Location& location, 62 ErrorType error_type, 63 const std::string& message, 64 ModelType model_type); 65 66 // Copy and assign via deep copy. 67 SyncError(const SyncError& other); 68 SyncError& operator=(const SyncError& other); 69 70 ~SyncError(); 71 72 // Reset the current error to a new datatype error. May be called 73 // irrespective of whether IsSet() is true. After this is called, IsSet() 74 // will return true. 75 // Will print the new error to LOG(ERROR). 76 void Reset(const tracked_objects::Location& location, 77 const std::string& message, 78 ModelType type); 79 80 // Whether this is a valid error or not. 81 bool IsSet() const; 82 83 // These must only be called if IsSet() is true. 84 const tracked_objects::Location& location() const; 85 const std::string& message() const; 86 ModelType model_type() const; 87 ErrorType error_type() const; 88 89 // Error severity for logging and UI purposes. 90 Severity GetSeverity() const; 91 // Type specific message prefix for logging and UI purposes. 92 std::string GetMessagePrefix() const; 93 94 // Returns empty string is IsSet() is false. 95 std::string ToString() const; 96 private: 97 // Print error information to log. 98 void PrintLogError() const; 99 100 // Make a copy of a SyncError. If other.IsSet() == false, this->IsSet() will 101 // now return false. 102 void Copy(const SyncError& other); 103 104 // Initialize the local error data with the specified error data. After this 105 // is called, IsSet() will return true. 106 void Init(const tracked_objects::Location& location, 107 const std::string& message, 108 ModelType model_type, 109 ErrorType error_type); 110 111 // Reset the error to it's default (unset) values. 112 void Clear(); 113 114 // scoped_ptr is necessary because Location objects aren't assignable. 115 scoped_ptr<tracked_objects::Location> location_; 116 std::string message_; 117 ModelType model_type_; 118 ErrorType error_type_; 119 }; 120 121 // gmock printer helper. 122 SYNC_EXPORT void PrintTo(const SyncError& sync_error, std::ostream* os); 123 124 } // namespace syncer 125 126 #endif // SYNC_API_SYNC_ERROR_H_ 127
