summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/cms/servlet/common/CMSFileLoader.java
blob: 4a5b767ef870c0e311287ec7a787ef3fa60ae9ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.cms.servlet.common;


import java.io.File;
import java.io.IOException;
import java.util.Hashtable;
import java.util.Enumeration;

import com.netscape.certsrv.base.IConfigStore;
import com.netscape.certsrv.base.EBaseException;


/**
 * CMSFileLoader - file cache.
 *
 * @version $Revision$, $Date$
 */

public class CMSFileLoader {
    // default max size
    public final int MAX_SIZE = 200;
    // default number of files to clear when max is reached.
    public final int CLEAR_SIZE = 50;
    // max size property
    public final String PROP_MAX_SIZE = "maxSize";
    // clear size property
    public final String PROP_CLEAR_SIZE = "clearSize";
    // property to cache templates only
    public final String PROP_CACHE_TEMPLATES_ONLY = "cacheTemplatesOnly";

    // hash of files to their content. 
    private Hashtable mLoadedFiles = new Hashtable();

    // max number of files 
    private int mMaxSize = MAX_SIZE;

    // number of files to clear when max is reached.
    private int mClearSize = CLEAR_SIZE;  

    // whether to cache templates and forms only.
    private boolean mCacheTemplatesOnly = true;

    public CMSFileLoader() {
    }

    public void init(IConfigStore config) throws EBaseException {
        mMaxSize = config.getInteger(PROP_MAX_SIZE, MAX_SIZE);
        mClearSize = config.getInteger(PROP_CLEAR_SIZE, CLEAR_SIZE);
        mCacheTemplatesOnly = 
                config.getBoolean(PROP_CACHE_TEMPLATES_ONLY, true);
    }

    // Changed by bskim
    //public byte[] get(String absPath) throws EBaseException, IOException {
    //	File file = new File(absPath);
    //	return get(file);
    //}
    public byte[] get(String absPath, String enc) throws EBaseException, IOException {
        File file = new File(absPath);

        return get(file, enc);
    }

    // Change end

    // Changed by bskim
    //public byte[] get(File file) throws EBaseException, IOException {
    //	CMSFile cmsFile = getCMSFile(file);
    public byte[] get(File file, String enc) throws EBaseException, IOException {
        CMSFile cmsFile = getCMSFile(file, enc);

        // Change end	    
        return cmsFile.getContent();
    }

    // Changed by bskim
    //public CMSFile getCMSFile(File file) throws EBaseException, IOException {
    public CMSFile getCMSFile(File file, String enc) throws EBaseException, IOException {
        // Change end	    
        String absPath = file.getAbsolutePath();
        long modified = file.lastModified();
        CMSFile cmsFile = (CMSFile) mLoadedFiles.get(absPath);
        long lastModified = (cmsFile == null ? 0 : cmsFile.getLastModified());

        // new file.
        if (cmsFile == null || modified != lastModified) {
            // Changed by bskim
            //cmsFile = updateFile(absPath, file); 
            cmsFile = updateFile(absPath, file, enc); 
            // Change end
        }
        cmsFile.setLastAccess(System.currentTimeMillis());
        return cmsFile;
    }

    // Changed by bskim
    //private CMSFile updateFile(String absPath, File file) 
    private CMSFile updateFile(String absPath, File file, String enc) 
        // Change end
        throws EBaseException, IOException {
        // clear if cache size exceeded.
        if (mLoadedFiles.size() >= mMaxSize) {
            clearSomeFiles();
        }

        CMSFile cmsFile = null;

        // check if file is a js template or plain template by its first String
        if (absPath.endsWith(CMSTemplate.SUFFIX)) {
            // Changed by bskim
            //cmsFile = new CMSTemplate(file);
            cmsFile = new CMSTemplate(file, enc);
            // End of Change
        } else {
            cmsFile = new CMSFile(file);
        }
        mLoadedFiles.put(absPath, cmsFile);  // replace old one if any.
        return cmsFile;
    }

    private synchronized void clearSomeFiles() {

        // recheck this in case some other thread has cleared it.
        if (mLoadedFiles.size() < mMaxSize) 
            return;

            // remove the LRU files.
            // XXX could be optimized more.
        Enumeration elements = mLoadedFiles.elements();

        for (int i = mClearSize; i > 0; i--) {
            long lru = java.lang.Long.MAX_VALUE;
            CMSFile lruFile = null;

            while (elements.hasMoreElements()) {
                CMSFile cmsFile = (CMSFile) elements.nextElement();

                if (cmsFile.getLastAccess() < lru) {
                    lruFile = cmsFile;
                }
                mLoadedFiles.remove(lruFile.getAbsPath());
            }
        }
    }
}