OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESFileContainer.cc
Go to the documentation of this file.
1 // BESFileContainer.cc
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #include "BESFileContainer.h"
34 #include "TheBESKeys.h"
35 
36 // Use the new caching code?
37 #define NEW_CACHE 1
38 
39 #if NEW_CACHE
40 // New cache system
41 #include "BESUncompressManager3.h"
42 #include "BESCache3.h"
43 #else
44 // Old cache system
45 #include "BESUncompressManager.h"
46 #include "BESCache.h"
47 #endif
48 #include "BESForbiddenError.h"
49 
56 BESFileContainer::BESFileContainer(const string &sym_name, const string &real_name, const string &type) :
57  BESContainer(sym_name, real_name, type)
58 {
59  string::size_type dotdot = real_name.find("..");
60  if (dotdot != string::npos) {
61  string s = (string) "'../' not allowed in container real name " + real_name;
62  throw BESForbiddenError(s, __FILE__, __LINE__);
63  }
64 }
65 
70 BESFileContainer::BESFileContainer(const BESFileContainer &copy_from) :
71  BESContainer(copy_from)
72 {
73 }
74 
76 {
77  BESContainer::_duplicate(copy_to);
78 }
79 
86 {
87  BESContainer *container = new BESFileContainer;
88  BESContainer::_duplicate(*container);
89  return container;
90 }
91 
98 {
99 #if NEW_CACHE
100  // Get a pointer to the singleton cache instance for this process.
101  BESCache3 *cache = BESCache3::get_instance(TheBESKeys::TheKeys(), (string) "BES.CacheDir",
102  (string) "BES.CachePrefix", (string) "BES.CacheSize");
103 
104  // If the file is in the cache, this is nearly a no-op; if the file is compressed,
105  // uncompress it, add it to the class and return the name of the file in the cache.
106  // In both of those cases, the file is cached, so we need to record that so that
107  // the release() method will remove the lock on the cached file. If the file is not
108  // a compressed file, the 'uncompress' function returns false and the contents of
109  // the value-result parameter '_target' is undefined.
110  _cached = BESUncompressManager3::TheManager()->uncompress(get_real_name(), _target, cache);
111  if (_cached)
112  return _target;
113  else
114  return get_real_name();
115 
116 #else
117 
118  // This is easy ... create the cache using the different keys
119  BESKeys *keys = TheBESKeys::TheKeys();
120  BESCache cache( *keys, "BES.CacheDir", "BES.CachePrefix", "BES.CacheSize" );
121 
122  _cached = BESUncompressManager::TheManager()->uncompress( get_real_name(), _target, cache );
123  if( _cached )
124  return _target;
125 
126  return get_real_name();
127 #endif
128 }
129 
138 {
139 #if NEW_CACHE
140  if (_cached)
142 #endif
143  return true;
144 }
145 
153 void BESFileContainer::dump(ostream &strm) const
154 {
155  strm << BESIndent::LMarg << "BESFileContainer::dump - (" << (void *) this << ")" << endl;
157  BESContainer::dump(strm);
159 }
160 
virtual string access()
returns the name of a file to access for this container, uncompressing if necessary.
Holds real data, container type and constraint for symbolic name read from persistence.
virtual void unlock_and_close(const string &target)
Unlock the named file.
Definition: BESCache3.cc:633
static void Indent()
Definition: BESIndent.cc:38
static BESUncompressManager3 * TheManager()
mapping of key/value pairs defining different behaviors of an application.
Definition: BESKeys.h:84
Implementation of a caching mechanism for compressed data.
Definition: BESCache3.h:71
static ostream & LMarg(ostream &strm)
Definition: BESIndent.cc:73
string get_real_name() const
retrieve the real name for this container, such as a file name.
Definition: BESContainer.h:141
virtual void _duplicate(BESContainer &copy_to)
void _duplicate(BESContainer &copy_to)
duplicate this instance into the passed container
Definition: BESContainer.cc:49
error thrown if the BES is not allowed to access the resource requested
virtual bool uncompress(const string &src, string &target, BESCache3 *cache)
If the file 'src' should be uncompressed, do so and return a new file name on the value-result param ...
virtual void dump(ostream &strm) const
Displays debug information about this object.
virtual void dump(ostream &strm) const
dumps information about this object
Definition: BESContainer.cc:65
A container is something that holds data.
Definition: BESContainer.h:60
static void UnIndent()
Definition: BESIndent.cc:44
virtual bool release()
release the file
static BESKeys * TheKeys()
Definition: TheBESKeys.cc:48
virtual BESContainer * ptr_duplicate()
duplicate this instances of BESFileContainer
static BESCache3 * get_instance()
Get an instance of the BESCache3 object.
Definition: BESCache3.cc:98