• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2009-2010 jMonkeyEngine
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  *   notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in the
14  *   documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
17  *   may be used to endorse or promote products derived from this software
18  *   without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 package com.jme3.asset.plugins;
34 
35 import com.jme3.asset.*;
36 import java.io.*;
37 
38 /**
39  * <code>FileLocator</code> allows you to specify a folder where to
40  * look for assets.
41  * @author Kirill Vainer
42  */
43 public class FileLocator implements AssetLocator {
44 
45     private File root;
46 
setRootPath(String rootPath)47     public void setRootPath(String rootPath) {
48         if (rootPath == null)
49             throw new NullPointerException();
50 
51         try {
52             root = new File(rootPath).getCanonicalFile();
53             if (!root.isDirectory()){
54                 throw new IllegalArgumentException("Given root path \"" + root + "\" not a directory");
55             }
56         } catch (IOException ex) {
57             throw new AssetLoadException("Root path is invalid", ex);
58         }
59     }
60 
61     private static class AssetInfoFile extends AssetInfo {
62 
63         private File file;
64 
AssetInfoFile(AssetManager manager, AssetKey key, File file)65         public AssetInfoFile(AssetManager manager, AssetKey key, File file){
66             super(manager, key);
67             this.file = file;
68         }
69 
70         @Override
openStream()71         public InputStream openStream() {
72             try{
73                 return new FileInputStream(file);
74             }catch (FileNotFoundException ex){
75                 // NOTE: Can still happen even if file.exists() is true, e.g.
76                 // permissions issue and similar
77                 throw new AssetLoadException("Failed to open file: " + file, ex);
78             }
79         }
80     }
81 
locate(AssetManager manager, AssetKey key)82     public AssetInfo locate(AssetManager manager, AssetKey key) {
83         String name = key.getName();
84         File file = new File(root, name);
85         if (file.exists() && file.isFile()){
86             try {
87                 // Now, check asset name requirements
88                 String canonical = file.getCanonicalPath();
89                 String absolute = file.getAbsolutePath();
90                 if (!canonical.endsWith(absolute)){
91                     throw new AssetNotFoundException("Asset name doesn't match requirements.\n"+
92                                                      "\"" + canonical + "\" doesn't match \"" + absolute + "\"");
93                 }
94             } catch (IOException ex) {
95                 throw new AssetLoadException("Failed to get file canonical path " + file, ex);
96             }
97 
98             return new AssetInfoFile(manager, key, file);
99         }else{
100             return null;
101         }
102     }
103 
104 }
105