include/gammu-backup.h

   1 /**
   2  * \file gammu-backup.h
   3  * \author Michal Čihař
   4  *
   5  * Backup data and functions.
   6  */
   7 #ifndef __gammu_backup_h
   8 #define __gammu_backup_h
   9
  10 /**
  11  * \defgroup Backup Backup
  12  * Backups manipulations.
  13  */
  14
  15 #include <gammu-message.h>
  16 #include <gammu-memory.h>
  17 #include <gammu-calendar.h>
  18 #include <gammu-bitmap.h>
  19 #include <gammu-wap.h>
  20 #include <gammu-settings.h>
  21 #include <gammu-ringtone.h>
  22 #include <gammu-config.h>
  23
  24 #ifdef GSM_ENABLE_BACKUP
  25
  26 /**
  27  * Maximal number of SMSes in backup.
  28  *
  29  * \todo This should not be hardcoded.
  30  */
  31 #define GSM_BACKUP_MAX_SMS 100000
  32
  33 /**
  34  * SMS backup data.
  35  *
  36  * \ingroup Backup
  37  */
  38 typedef struct {
  39         /**
  40          * List of SMS messages.
  41          */
  42         GSM_SMSMessage *SMS[GSM_BACKUP_MAX_SMS + 1];
  43 } GSM_SMS_Backup;
  44
  45 /**
  46  * Reads SMS backup file.
  47  *
  48  * \ingroup Backup
  49  *
  50  * \param FileName file name
  51  * \param backup structure where backup will be stored
  52  *
  53  * \return Error code
  54  */
  55 GSM_Error GSM_ReadSMSBackupFile(const char *FileName, GSM_SMS_Backup * backup);
  56
  57 /**
  58  * Adds data to SMS backup file.
  59  *
  60  * \ingroup Backup
  61  *
  62  * \param FileName file name
  63  * \param backup structure holding backup data
  64  *
  65  * \return Error code
  66  */
  67 GSM_Error GSM_AddSMSBackupFile(const char *FileName, GSM_SMS_Backup * backup);
  68
  69 /**
  70  * Clears SMS backup structure
  71  *
  72  * \ingroup Backup
  73  *
  74  * \param backup structure where backup data will be stored
  75  */
  76 void GSM_ClearSMSBackup(GSM_SMS_Backup * backup);
  77
  78 /**
  79  * Deallocates all members of SMS backup structure
  80  *
  81  * \ingroup Backup
  82  *
  83  * \param backup structure where backup data will be stored
  84  */
  85 void GSM_FreeSMSBackup(GSM_SMS_Backup * backup);
  86
  87 /**
  88  * Maximal number of phonebook entries in backup.
  89  *
  90  * \ingroup Backup
  91  *
  92  * \todo This should not be hardcoded.
  93  */
  94 #define GSM_BACKUP_MAX_PHONEPHONEBOOK 1001
  95 /**
  96  * Maximal number of SIM entries in backup.
  97  *
  98  * \ingroup Backup
  99  *
 100  * \todo This should not be hardcoded.
 101  */
 102 #define GSM_BACKUP_MAX_SIMPHONEBOOK 251
 103 /**
 104  * Maximal number of caller groups in backup.
 105  *
 106  * \ingroup Backup
 107  *
 108  * \todo This should not be hardcoded.
 109  */
 110 #define GSM_BACKUP_MAX_CALLER 101
 111 /**
 112  * Maximal number of SMSC in backup.
 113  *
 114  * \ingroup Backup
 115  *
 116  * \todo This should not be hardcoded.
 117  */
 118 #define GSM_BACKUP_MAX_SMSC 10
 119 /**
 120  * Maximal number of WAP bookmarks in backup.
 121  *
 122  * \ingroup Backup
 123  *
 124  * \todo This should not be hardcoded.
 125  */
 126 #define GSM_BACKUP_MAX_WAPBOOKMARK 40
 127 /**
 128  * Maximal number of WAP settings in backup.
 129  *
 130  * \ingroup Backup
 131  *
 132  * \todo This should not be hardcoded.
 133  */
 134 #define GSM_BACKUP_MAX_WAPSETTINGS 30
 135 /**
 136  * Maximal number of MMS settings in backup.
 137  *
 138  * \ingroup Backup
 139  *
 140  * \todo This should not be hardcoded.
 141  */
 142 #define GSM_BACKUP_MAX_MMSSETTINGS 30
 143 /**
 144  * Maximal number of SyncML settings in backup.
 145  *
 146  * \ingroup Backup
 147  *
 148  * \todo This should not be hardcoded.
 149  */
 150 #define GSM_BACKUP_MAX_SYNCMLSETTINGS 30
 151 /**
 152  * Maximal number of chat settings in backup.
 153  *
 154  * \ingroup Backup
 155  *
 156  * \todo This should not be hardcoded.
 157  */
 158 #define GSM_BACKUP_MAX_CHATSETTINGS 30
 159 /**
 160  * Maximal number of ringtones in backup.
 161  *
 162  * \ingroup Backup
 163  *
 164  * \todo This should not be hardcoded.
 165  */
 166 #define GSM_BACKUP_MAX_RINGTONES 30
 167 /**
 168  * Maximal number of profiles in backup.
 169  *
 170  * \ingroup Backup
 171  *
 172  * \todo This should not be hardcoded.
 173  */
 174 #define GSM_BACKUP_MAX_PROFILES 10
 175 /**
 176  * Maximal number of FM stations in backup.
 177  *
 178  * \ingroup Backup
 179  *
 180  * \todo This should not be hardcoded.
 181  */
 182 #define GSM_BACKUP_MAX_FMSTATIONS 20
 183 /**
 184  * Maximal number of GPRS points in backup.
 185  *
 186  * \ingroup Backup
 187  *
 188  * \todo This should not be hardcoded.
 189  */
 190 #define GSM_BACKUP_MAX_GPRSPOINT 10
 191 /**
 192  * Maximal number of notes in backup.
 193  *
 194  * \ingroup Backup
 195  *
 196  * \todo This should not be hardcoded.
 197  */
 198 #define GSM_BACKUP_MAX_NOTE 50
 199
 200 /**
 201  * Backup data.
 202  *
 203  * \ingroup Backup
 204  */
 205 typedef struct {
 206         /**
 207          * IMEI of phone which has been backed up
 208          */
 209         char IMEI[GSM_MAX_IMEI_LENGTH];
 210         /**
 211          * Model of phone which has been backed up
 212          */
 213         char Model[GSM_MAX_MODEL_LENGTH + GSM_MAX_VERSION_LENGTH];
 214         /**
 215          * Name of program which created backup
 216          */
 217         char Creator[80];
 218         /**
 219          * Timestamp of backup
 220          */
 221         GSM_DateTime DateTime;
 222         /**
 223          * Whether timestamp is present
 224          */
 225         gboolean DateTimeAvailable;
 226         /**
 227          * Original MD5 of backup from file
 228          */
 229         char MD5Original[100];
 230         /**
 231          * Calculated MD5 of backup
 232          */
 233         char MD5Calculated[100];
 234         /**
 235          * Phone phonebook
 236          */
 237         GSM_MemoryEntry *PhonePhonebook[GSM_BACKUP_MAX_PHONEPHONEBOOK + 1];
 238         /**
 239          * SIM phonebook
 240          */
 241         GSM_MemoryEntry *SIMPhonebook[GSM_BACKUP_MAX_SIMPHONEBOOK + 1];
 242         /**
 243          * Calendar
 244          */
 245         GSM_CalendarEntry *Calendar[GSM_MAXCALENDARTODONOTES + 1];
 246         /**
 247          * Caller logos
 248          */
 249         GSM_Bitmap *CallerLogos[GSM_BACKUP_MAX_CALLER + 1];
 250         /**
 251          * SMS configuration
 252          */
 253         GSM_SMSC *SMSC[GSM_BACKUP_MAX_SMSC + 1];
 254         /**
 255          * WAP bookmarks
 256          */
 257         GSM_WAPBookmark *WAPBookmark[GSM_BACKUP_MAX_WAPBOOKMARK + 1];
 258         /**
 259          * WAP settings
 260          */
 261         GSM_MultiWAPSettings *WAPSettings[GSM_BACKUP_MAX_WAPSETTINGS + 1];
 262         /**
 263          * MMS settings
 264          */
 265         GSM_MultiWAPSettings *MMSSettings[GSM_BACKUP_MAX_MMSSETTINGS + 1];
 266         /**
 267          * SyncMC settings
 268          */
 269         GSM_SyncMLSettings *SyncMLSettings[GSM_BACKUP_MAX_SYNCMLSETTINGS + 1];
 270         /**
 271          * Chat settings
 272          */
 273         GSM_ChatSettings *ChatSettings[GSM_BACKUP_MAX_CHATSETTINGS + 1];
 274         /**
 275          * Ringtones
 276          */
 277         GSM_Ringtone *Ringtone[GSM_BACKUP_MAX_RINGTONES + 1];
 278         /**
 279          * To do tasks
 280          */
 281         GSM_ToDoEntry *ToDo[GSM_MAXCALENDARTODONOTES + 1];
 282         /**
 283          * Progiles
 284          */
 285         GSM_Profile *Profiles[GSM_BACKUP_MAX_PROFILES + 1];
 286         /**
 287          * FM stations
 288          */
 289         GSM_FMStation *FMStation[GSM_BACKUP_MAX_FMSTATIONS + 1];
 290         /**
 291          * GPRS configurations
 292          */
 293         GSM_GPRSAccessPoint *GPRSPoint[GSM_BACKUP_MAX_GPRSPOINT + 1];
 294         /**
 295          * Notes
 296          */
 297         GSM_NoteEntry *Note[GSM_BACKUP_MAX_NOTE + 1];
 298         /**
 299          * Statup logo
 300          */
 301         GSM_Bitmap *StartupLogo;
 302         /**
 303          * Operator logo
 304          */
 305         GSM_Bitmap *OperatorLogo;
 306 } GSM_Backup;
 307
 308 /**
 309  * Backup data.
 310  *
 311  * \ingroup Backup
 312  */
 313 typedef enum {
 314         /**
 315          * Compatibility with old gboolean used instead of format.
 316          *
 317          * File type is guessed for extension, non unicode format used
 318          * for Gammu backup.
 319          */
 320         GSM_Backup_Auto = 0,
 321         /**
 322          * Compatibility with old gboolean used instead of format.
 323          *
 324          * File type is guessed for extension, unicode format used
 325          * for Gammu backup.
 326          */
 327         GSM_Backup_AutoUnicode = 1,
 328         /**
 329          * LMB format, compatible with Logo manager, can store
 330          * phonebooks and logos.
 331          */
 332         GSM_Backup_LMB,
 333         /**
 334          * vCalendar standard, can store todo and calendar entries.
 335          */
 336         GSM_Backup_VCalendar,
 337         /**
 338          * vCard standard, can store phone phonebook entries.
 339          */
 340         GSM_Backup_VCard,
 341         /**
 342          * LDIF (LDAP Data Interchange Format), can store phone
 343          * phonebook entries.
 344          */
 345         GSM_Backup_LDIF,
 346         /**
 347          * iCalendar standard, can store todo and calendar entries.
 348          */
 349         GSM_Backup_ICS,
 350         /**
 351          * Gammu own format can store almost anything from phone.
 352          *
 353          * This is ASCII version of the format, Unicode strings are HEX
 354          * encoded. Use GSM_Backup_GammuUCS2 instead if possible.
 355          */
 356         GSM_Backup_Gammu,
 357         /**
 358          * Gammu own format can store almost anything from phone.
 359          *
 360          * This is UCS2-BE version of the format.
 361          */
 362         GSM_Backup_GammuUCS2,
 363         /**
 364          * vNote standard, can store phone notes.
 365          */
 366         GSM_Backup_VNote,
 367 } GSM_BackupFormat;
 368
 369 /**
 370  * Save backup file.
 371  *
 372  * \ingroup Backup
 373  *
 374  * \param FileName Name of file (format is detected from it).
 375  * \param Backup structure holding backup data
 376  * \param Format Backup format.
 377  *
 378  * \return Error code
 379  */
 380 GSM_Error GSM_SaveBackupFile(char *FileName, GSM_Backup * Backup,
 381                              GSM_BackupFormat Format);
 382
 383 /**
 384  * Guesses backup format based on filename.
 385  *
 386  * \ingroup Backup
 387  *
 388  * \param FileName Name of backup filename.
 389  * \param UseUnicode Whether to prefer unicode variant when guessing.
 390  *
 391  * \return Backup format on success -1 on error.
 392  */
 393 GSM_BackupFormat GSM_GuessBackupFormat(const char *FileName,
 394                                        const gboolean UseUnicode);
 395
 396 /**
 397  * Reads data from backup file.
 398  *
 399  * \ingroup Backup
 400  *
 401  * \param FileName Name of file (format is detected from it).
 402  * \param backup structure where backup data will be stored
 403  * \param Format Format of backup. For Gammu backups, unicode subformats
 404  * are ignored.
 405  *
 406  * \return Error code
 407  */
 408 GSM_Error GSM_ReadBackupFile(const char *FileName, GSM_Backup * backup,
 409                              GSM_BackupFormat Format);
 410
 411 /**
 412  * Clears backup structure
 413  *
 414  * \ingroup Backup
 415  *
 416  * \param backup structure where backup data will be stored
 417  */
 418 void GSM_ClearBackup(GSM_Backup * backup);
 419
 420 /**
 421  * Deallocates all members of backup structure
 422  *
 423  * \ingroup Backup
 424  *
 425  * \param backup structure where backup data will be stored
 426  */
 427 void GSM_FreeBackup(GSM_Backup * backup);
 428
 429 /**
 430  * Information about supported backup features.
 431  *
 432  * \ingroup Backup
 433  */
 434 typedef struct {
 435         gboolean UseUnicode;
 436         gboolean IMEI;
 437         gboolean Model;
 438         gboolean DateTime;
 439         gboolean ToDo;
 440         gboolean PhonePhonebook;
 441         gboolean SIMPhonebook;
 442         gboolean Calendar;
 443         gboolean CallerLogos;
 444         gboolean SMSC;
 445         gboolean WAPBookmark;
 446         gboolean Profiles;
 447         gboolean WAPSettings;
 448         gboolean MMSSettings;
 449         gboolean SyncMLSettings;
 450         gboolean ChatSettings;
 451         gboolean Ringtone;
 452         gboolean StartupLogo;
 453         gboolean OperatorLogo;
 454         gboolean FMStation;
 455         gboolean GPRSPoint;
 456         gboolean Note;
 457 } GSM_Backup_Info;
 458
 459 /**
 460  * Gets information about format features.
 461  *
 462  * \param Format Format of backup.
 463  * \param info Output information about backup features.
 464  *
 465  * \ingroup Backup
 466  */
 467 void GSM_GetBackupFormatFeatures(GSM_BackupFormat Format,
 468                                  GSM_Backup_Info * info);
 469
 470 /**
 471  * Gets information about backup data features (resp. which data it contains).
 472  *
 473  * \param Format Format of backup.
 474  * \param info Output information about backup features.
 475  * \param backup Backup data to chech.
 476  *
 477  * \ingroup Backup
 478  */
 479 void GSM_GetBackupFileFeatures(GSM_BackupFormat Format, GSM_Backup_Info * info,
 480                                GSM_Backup * backup);
 481
 482 #endif
 483
 484 #endif
 485
 486 /* Editor configuration
 487  * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 488  */