src/r_timezone.cc

   1 ///
   2 /// \file       r_timezone.cc
   3 ///             Record parsing class for the timezone database.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2011, Net Direct Inc. (http://www.netdirect.ca/)
   8     Copyright (C) 2008, Brian Edginton
   9
  10     This program is free software; you can redistribute it and/or modify
  11     it under the terms of the GNU General Public License as published by
  12     the Free Software Foundation; either version 2 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  18
  19     See the GNU General Public License in the COPYING file at the
  20     root directory of this project for more details.
  21 */
  22
  23 #include "r_timezone.h"
  24 #include "record-internal.h"
  25 #include "protostructs.h"
  26 #include "data.h"
  27 #include "time.h"
  28 #include "iconv.h"
  29 #include "debug.h"
  30 #include <iostream>
  31 #include <sstream>
  32 #include <iomanip>
  33 #include "ios_state.h"
  34
  35 using namespace std;
  36 using namespace Barry::Protocol;
  37
  38 namespace Barry
  39 {
  40
  41 ///////////////////////////////////////////////////////////////////////////////
  42 // Timezone Class
  43
  44 // Timezone Field Codes
  45 #define TZFC_INDEX              0x01
  46 #define TZFC_NAME               0x02
  47 #define TZFC_OFFSET             0x03
  48 #define TZFC_DST                0x04
  49 #define TZFC_STARTMONTH         0x06
  50 #define TZFC_ENDMONTH           0x0B
  51 #define TZFC_TZTYPE             0x64
  52
  53 #define TZFC_END                0xffff
  54
  55 static FieldLink<Timezone> TimezoneFieldLinks[] = {
  56    { TZFC_NAME,   "Name",        0, 0, &Timezone::TimeZoneName, 0, 0, 0, 0, true },
  57    { TZFC_END,    "End of List", 0, 0, 0, 0, 0, 0, 0, false },
  58 };
  59
  60 Timezone::Timezone()
  61 {
  62         Clear();
  63 }
  64
  65 Timezone::~Timezone()
  66 {
  67 }
  68
  69 const unsigned char* Timezone::ParseField(const unsigned char *begin,
  70                                           const unsigned char *end,
  71                                           const IConverter *ic)
  72 {
  73         const CommonField *field = (const CommonField *) begin;
  74
  75         // advance and check size
  76         begin += COMMON_FIELD_HEADER_SIZE + btohs(field->size);
  77         if( begin > end )       // if begin==end, we are ok
  78                 return begin;
  79
  80         if( !btohs(field->size) )   // if field has no size, something's up
  81                 return begin;
  82
  83         if( field->type == TZFC_TZTYPE ) {
  84                 if( ( TZType = field->u.uint32 ) != 1 ) {
  85                         throw Error("Timezone::ParseField: Timezone Type is not valid");
  86                 }
  87                 return begin;
  88         }
  89
  90         // cycle through the type table
  91         for(    FieldLink<Timezone> *b = TimezoneFieldLinks;
  92                 b->type != TZFC_END;
  93                 b++ )
  94         {
  95                 if( b->type == field->type ) {
  96                         if( b->strMember ) {
  97                                 std::string &s = this->*(b->strMember);
  98                                 s = ParseFieldString(field);
  99                                 if( b->iconvNeeded && ic )
 100                                         s = ic->FromBB(s);
 101                                 return begin;   // done!
 102                         }
 103                 }
 104         }
 105
 106         switch( field->type )
 107         {
 108         case TZFC_INDEX:
 109                 Index = btohl(field->u.uint32);
 110                 return begin;
 111
 112         case TZFC_OFFSET:
 113                 Offset = btohs(field->u.int16);
 114                 if (Offset < 0) {
 115                         Offset =~ Offset;
 116                         Offset++;
 117                         OffsetFraction = Offset % 60;
 118                         Offset = Offset / 60;
 119                         Left = true;
 120                 } else {
 121                         OffsetFraction = Offset % 60;
 122                         Offset = Offset / 60;
 123                         Left = false;
 124                 }
 125                 return begin;
 126
 127         case TZFC_DST:
 128                 DSTOffset = btohl(field->u.uint32);
 129                 if (DSTOffset) {
 130                         UseDST = true;
 131                 }
 132                 return begin;
 133
 134         case TZFC_STARTMONTH:
 135                 StartMonth = btohl(field->u.uint32);
 136                 return begin;
 137
 138         case TZFC_ENDMONTH:
 139                 EndMonth = btohl(field->u.uint32);
 140                 return begin;
 141         }
 142
 143         // if still not handled, add to the Unknowns list
 144         UnknownField uf;
 145         uf.type = field->type;
 146         uf.data.assign((const char*)field->u.raw, btohs(field->size));
 147         Unknowns.push_back(uf);
 148
 149         // return new pointer for next field
 150         return begin;
 151 }
 152
 153 void Timezone::ParseHeader(const Data &data, size_t &offset)
 154 {
 155         // no header in Task records
 156 }
 157
 158 void Timezone::ParseFields(const Data &data, size_t &offset, const IConverter *ic)
 159 {
 160         const unsigned char *finish = ParseCommonFields(*this,
 161                 data.GetData() + offset, data.GetData() + data.GetSize(), ic);
 162         offset += finish - (data.GetData() + offset);
 163 }
 164
 165 void Timezone::BuildHeader(Data &data, size_t &offset) const
 166 {
 167         // not yet implemented
 168 }
 169
 170 void Timezone::BuildFields(Data &data, size_t &offset, const IConverter *ic) const
 171 {
 172         // not yet implemented
 173 }
 174
 175 void Timezone::Clear()
 176 {
 177         RecType = GetDefaultRecType();
 178         RecordId = 0;
 179
 180         TZType = 0;
 181         DSTOffset = 0;
 182         Index = 0;
 183         Offset = 0;
 184         OffsetFraction = 0;
 185         StartMonth = -1;
 186         EndMonth = -1;
 187         Left = false;
 188         UseDST = false;
 189
 190         TimeZoneName.clear();
 191
 192         Unknowns.clear();
 193 }
 194
 195 std::string Timezone::GetDescription() const
 196 {
 197         ostringstream oss;
 198         oss << TimeZoneName << " ("
 199             << (Left ? "-" : "+") << dec << Offset << "." << OffsetFraction
 200             << ")";
 201         return oss.str();
 202 }
 203
 204 void Timezone::Dump(std::ostream &os) const
 205 {
 206         ios_format_state state(os);
 207
 208         static const char *month[] = {
 209                         "Jan", "Feb", "Mar", "Apr", "May",
 210                         "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
 211         };
 212
 213         os << "Task entry: 0x" << setbase(16) << RecordId
 214            << " (" << (unsigned int)RecType << ")\n";
 215
 216         // cycle through the type table
 217         for(    const FieldLink<Timezone> *b = TimezoneFieldLinks;
 218                 b->type != TZFC_END;
 219                 b++ )
 220         {
 221                 if( b->strMember ) {
 222                         const std::string &s = this->*(b->strMember);
 223                         if( s.size() )
 224                                 os << "       " << b->name << ": " << s << "\n";
 225                 }
 226         }
 227
 228         os << "      Index: 0x" <<setw(2) << Index << "\n";
 229         os << "     Offset: " << (Left ? "-" : "+") << setbase(10) << Offset << "." << OffsetFraction << "\n";
 230         os << "    Use DST: " << (UseDST ? "true" : "false") << "\n";
 231         if (UseDST) {
 232                 if ((StartMonth > 0) && (StartMonth < 11))
 233                                 os << "Start Month: " << month[StartMonth] << "\n";
 234                 else
 235                                 os << "Start Month: unknown (" << setbase(10) << StartMonth << ")\n";
 236                 if ((EndMonth > 0) && (EndMonth < 11))
 237                         os << "  End Month: " << month[EndMonth] << "\n";
 238                 else
 239                         os << "  End Month: unknown (" << setbase(10) << EndMonth << ")\n";
 240         }
 241
 242         os << Unknowns;
 243         os << "\n\n";
 244 }
 245
 246 }