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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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,
57  const string &real_name,
58  const string &type )
59  : BESContainer( sym_name, real_name, type )
60 {
61  string::size_type dotdot = real_name.find( ".." ) ;
62  if( dotdot != string::npos )
63  {
64  string s = (string)"'../' not allowed in container real name "
65  + real_name ;
66  throw BESForbiddenError( s, __FILE__, __LINE__ ) ;
67  }
68 }
69 
74 BESFileContainer::BESFileContainer( const BESFileContainer &copy_from )
75  : BESContainer( copy_from )
76 {
77 }
78 
79 void
81 {
82  BESContainer::_duplicate( copy_to ) ;
83 }
84 
91 {
92  BESContainer *container = new BESFileContainer ;
93  BESContainer::_duplicate( *container ) ;
94  return container ;
95 }
96 
102 string
104 {
105 #if NEW_CACHE
106  // Get a pointer to the singleton cache instance for this process.
107  BESCache3 *cache = BESCache3::get_instance(TheBESKeys::TheKeys(), (string)"BES.CacheDir",
108  (string)"BES.CachePrefix", (string)"BES.CacheSize");
109 
110  // If the file is in the cache, this is nearly a no-op; if the file is compressed,
111  // decompress it, add it to the class and return the name of the file in the cache.
112  // In both of those cases, the file is cached, so we need to record that so that
113  // the release() method will remove the lock on the cached file. If the file is not
114  // a compressed file, the 'uncompress' function returns false and the contents of
115  // the value-result parameter '_target' is undefined.
116  _cached = BESUncompressManager3::TheManager()->uncompress( get_real_name(), _target, cache ) ;
117  if (_cached)
118  return _target;
119  else
120  return get_real_name();
121 
122 #else
123 
124  // This is easy ... create the cache using the different keys
125  BESKeys *keys = TheBESKeys::TheKeys() ;
126  BESCache cache( *keys, "BES.CacheDir", "BES.CachePrefix", "BES.CacheSize" );
127 
128  _cached = BESUncompressManager::TheManager()->uncompress( get_real_name(), _target, cache ) ;
129  if( _cached )
130  return _target ;
131 
132  return get_real_name() ;
133 #endif
134 }
135 
143 bool
145 {
146 #if NEW_CACHE
147  if (_cached)
149 #endif
150  return true ;
151 }
152 
160 void
161 BESFileContainer::dump( ostream &strm ) const
162 {
163  strm << BESIndent::LMarg << "BESFileContainer::dump - ("
164  << (void *)this << ")" << endl ;
166  BESContainer::dump( strm ) ;
168 }
169