src/lib/Torrus/DB.pm

   1 #  Copyright (C) 2002  Stanislav Sinyagin
   2 #
   3 #  This program is free software; you can redistribute it and/or modify
   4 #  it under the terms of the GNU General Public License as published by
   5 #  the Free Software Foundation; either version 2 of the License, or
   6 #  (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software
  15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  16
  17 # $Id: DB.pm,v 1.1 2012/01/08 23:58:23 root Exp root $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 # Dean Hamstead <dean@fragfest.com.au>
  20
  21 package Torrus::DB;
  22
  23 use strict;
  24 use warnings;
  25
  26 use Torrus::Log;
  27
  28 our $VERSION = 1.0;
  29
  30 our $dbType; # this is set in torrus-config.pl or torrus-siteconfig.pl
  31
  32 sub new
  33 {
  34     my $c = shift;
  35     my @args = @_;
  36
  37     my $location = "Torrus/DB/${dbType}.pm";
  38     my $class = "Torrus::DB::$dbType";
  39
  40     require $location;
  41
  42     return $class->new(@args)
  43 }
  44
  45
  46 # It is strongly inadvisable to do anything inside a signal handler when DB
  47 # operation is in progress
  48
  49 our $interrupted = 0;
  50
  51 my $signalHandlersSet = 0;
  52 my $safeSignals = 0;
  53
  54
  55
  56
  57
  58 sub setSignalHandlers
  59 {
  60     if( $signalHandlersSet )
  61     {
  62         return;
  63     }
  64
  65     $SIG{'TERM'} = sub {
  66         if( $safeSignals )
  67         {
  68             Warn('Received SIGTERM. Scheduling to exit.');
  69             $interrupted = 1;
  70         }
  71         else
  72         {
  73             Warn('Received SIGTERM. Stopping the process.');
  74             exit(1);
  75         }
  76     };
  77
  78     $SIG{'INT'} = sub {
  79         if( $safeSignals )
  80         {
  81             Warn('Received SIGINT. Scheduling to exit.');
  82             $interrupted = 1;
  83         }
  84         else
  85         {
  86             Warn('Received SIGINT. Stopping the process');
  87             exit(1);
  88         }
  89     };
  90
  91
  92     $SIG{'PIPE'} = sub {
  93         if( $safeSignals )
  94         {
  95             Warn('Received SIGPIPE. Scheduling to exit.');
  96             $interrupted = 1;
  97         }
  98         else
  99         {
 100             Warn('Received SIGPIPE. Stopping the process');
 101             exit(1);
 102         }
 103     };
 104
 105     $SIG{'QUIT'} = sub {
 106         if( $safeSignals )
 107         {
 108             Warn('Received SIGQUIT. Scheduling to exit.');
 109             $interrupted = 1;
 110         }
 111         else
 112         {
 113             Warn('Received SIGQUIT. Stopping the process');
 114             exit(1);
 115         }
 116     };
 117
 118     $signalHandlersSet = 1;
 119     return;
 120 }
 121
 122
 123 sub setSafeSignalHandlers
 124 {
 125     setSignalHandlers();
 126     $safeSignals = 1;
 127     return;
 128 }
 129
 130
 131 sub setUnsafeSignalHandlers
 132 {
 133     setSignalHandlers();
 134     $safeSignals = 0;
 135     return;
 136 }
 137
 138 =head2 checkInterrupted
 139
 140 If we were previously interrupted, gracefully exit now
 141
 142 =cut
 143
 144 sub checkInterrupted
 145 {
 146     if( $interrupted )
 147     {
 148         Warn('Stopping the process');
 149         exit(1);
 150     }
 151     return;
 152 }
 153
 154
 155
 156 sub closeNow
 157 {
 158 die 'This should be implemented in the DB/Foo.pm package';
 159 }
 160
 161 sub cleanupEnvironment
 162 {
 163     # this is pretty crappy but will do for now
 164     # a better approach would be to use the objects and let them
 165     # clean themselves when they are destroyed
 166     for my $janitor (@Torrus::DB::cleanUp)
 167     {
 168         $janitor->();
 169     }
 170     return
 171
 172 }
 173
 174
 175 sub delay
 176 {
 177     my $self = shift;
 178     $self->{'delay_list_commit'} = 1;
 179     return
 180 }
 181
 182
 183 sub trunc
 184 {
 185 die 'This should be implemented in the DB/Foo.pm package';
 186 }
 187
 188
 189 sub put
 190 {
 191 die 'This should be implemented in the DB/Foo.pm package';
 192 }
 193
 194 sub get
 195 {
 196 die 'This should be implemented in the DB/Foo.pm package';
 197 }
 198
 199
 200 sub del
 201 {
 202 die 'This should be implemented in the DB/Foo.pm package';
 203 }
 204
 205
 206 sub cursor
 207 {
 208 die 'This should be implemented in the DB/Foo.pm package';
 209 }
 210
 211
 212 sub next
 213 {
 214 die 'This should be implemented in the DB/Foo.pm package';
 215 }
 216
 217 sub c_del
 218 {
 219 die 'This should be implemented in the DB/Foo.pm package';
 220 }
 221
 222
 223 sub c_get
 224 {
 225 die 'This should be implemented in the DB/Foo.pm package';
 226 }
 227
 228 sub c_put
 229 {
 230 die 'This should be implemented in the DB/Foo.pm package';
 231 }
 232
 233
 234 sub c_close
 235 {
 236 die 'This should be implemented in the DB/Foo.pm package';
 237 }
 238
 239
 240 sub getBestMatch
 241 {
 242 die 'This should be implemented in the DB/Foo.pm package';
 243 }
 244
 245
 246 sub searchPrefix
 247 {
 248 die 'This should be implemented in the DB/Foo.pm package';
 249 }
 250
 251
 252 sub searchSubstring
 253 {
 254 die 'This should be implemented in the DB/Foo.pm package';
 255 }
 256
 257
 258 sub addToList
 259 {
 260 die 'This should be implemented in the DB/Foo.pm package';
 261 }
 262
 263
 264 sub searchList
 265 {
 266 die 'This should be implemented in the DB/Foo.pm package';
 267 }
 268
 269
 270 sub delFromList
 271 {
 272 die 'This should be implemented in the DB/Foo.pm package';
 273 }
 274
 275
 276 sub getListItems
 277 {
 278 die 'This should be implemented in the DB/Foo.pm package';
 279 }
 280
 281
 282
 283 sub deleteList
 284 {
 285 die 'This should be implemented in the DB/Foo.pm package';
 286 }
 287
 288
 289 sub commit
 290 {
 291 die 'This should be implemented in the DB/Foo.pm package';
 292 }
 293
 294
 295
 296 1;
 297
 298
 299 # Local Variables:
 300 # mode: perl
 301 # indent-tabs-mode: nil
 302 # perl-indent-level: 4
 303 # End: