4f8d985b6686f325100fcf4abc0e1c183483f0ec
[pithos-web-client] / src / gr / grnet / pithos / web / client / foldertree / Folder.java
1 /*
2  * Copyright 2011 GRNET S.A. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or
5  * without modification, are permitted provided that the following
6  * conditions are met:
7  *
8  *   1. Redistributions of source code must retain the above
9  *      copyright notice, this list of conditions and the following
10  *      disclaimer.
11  *
12  *   2. Redistributions in binary form must reproduce the above
13  *      copyright notice, this list of conditions and the following
14  *      disclaimer in the documentation and/or other materials
15  *      provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * The views and conclusions contained in the software and
31  * documentation are those of the authors and should not be
32  * interpreted as representing official policies, either expressed
33  * or implied, of GRNET S.A.
34  */
35
36 package gr.grnet.pithos.web.client.foldertree;
37
38 import gr.grnet.pithos.web.client.Pithos;
39
40 import java.util.Date;
41 import java.util.HashMap;
42 import java.util.LinkedHashSet;
43 import java.util.Map;
44 import java.util.Set;
45
46 import com.google.gwt.core.client.GWT;
47 import com.google.gwt.http.client.Response;
48 import com.google.gwt.i18n.client.DateTimeFormat;
49 import com.google.gwt.i18n.client.DateTimeFormat.PredefinedFormat;
50 import com.google.gwt.json.client.JSONArray;
51 import com.google.gwt.json.client.JSONObject;
52 import com.google.gwt.json.client.JSONParser;
53 import com.google.gwt.json.client.JSONValue;
54
55 public class Folder extends Resource {
56     /*
57      * The name of the folder. If the folder is a container this is its name. If it is a virtual folder this is the
58      * last part of its path
59      */
60     private String name = null;
61
62     private Date lastModified = null;
63
64     private long bytesUsed = 0;
65
66     private Folder parent = null;
67     
68     private Set<Folder> subfolders = new LinkedHashSet<Folder>();
69     /*
70      * The name of the container that this folder belongs to. If this folder is container, this field equals name
71      */
72     private String container = null;
73
74     /*
75      * This is the full path of the folder (prefix is a misnomer but it was named so because this is used as a prefix=
76      * parameter in the request that fetches its children). If the folder is a cointainer this is empty string
77      */
78     private String prefix = "";
79
80     private Set<File> files = new LinkedHashSet<File>();
81
82     private Set<String> tags = new LinkedHashSet<String>();
83
84     private String owner;
85
86     private Map<String, Boolean[]> permissions = new HashMap<String, Boolean[]>();
87
88     private String inheritedPermissionsFrom;
89
90     public Folder() {};
91
92     public Folder(String name) {
93         this.name = name;
94     }
95     
96     public String getName() {
97         return name;
98     }
99
100     @Override
101         public Date getLastModified() {
102         return lastModified;
103     }
104
105     public long getBytesUsed() {
106         return bytesUsed;
107     }
108
109     public Set<Folder> getSubfolders() {
110         return subfolders;
111     }
112
113     public void setSubfolders(Set<Folder> subfolders) {
114         this.subfolders = subfolders;
115     }
116
117     public String getContainer() {
118         return container;
119     }
120
121     public String getPrefix() {
122         return prefix;
123     }
124
125     private void parsePermissions(String rawPermissions) {
126         String[] readwrite = rawPermissions.split(";");
127         for (String s : readwrite) {
128             String[] part = s.split("=");
129             String perm = part[0].trim();
130             String[] users = part[1].split(",");
131             for (String u : users) {
132                 String user = u.trim();
133                 Boolean[] userPerm = permissions.get(u);
134                 if (userPerm == null) {
135                     userPerm = new Boolean[2];
136                     permissions.put(user, userPerm);
137                 }
138                 if (perm.equals("read")) {
139                     userPerm[0] = Boolean.TRUE;
140                 }
141                 else if (perm.equals("write")) {
142                     userPerm[1] = Boolean.TRUE;
143                 }
144             }
145         }
146     }
147
148     public void populate(String _owner, Response response) {
149         this.owner = _owner;
150         String header = response.getHeader("Last-Modified");
151         if (header != null)
152                         try {
153                                 lastModified = DateTimeFormat.getFormat(PredefinedFormat.RFC_2822).parse(header);
154                         } catch (IllegalArgumentException e) {
155                                 GWT.log("Last-Modified will be set to null", e);
156                                 lastModified = null;
157                         }
158
159         header = response.getHeader("X-Container-Bytes-Used");
160         if (header != null && header.length() > 0)
161             bytesUsed = Long.valueOf(header);
162
163         header = response.getHeader("X-Container-Object-Meta");
164         if (header != null && header.length() > 0) {
165             for (String t : header.split(",")) {
166                 tags.add(t.toLowerCase().trim());
167             }
168         }
169
170         subfolders.clear(); //This is necessary in case we update a pre-existing Folder so that stale subfolders won't show up
171         files.clear();
172         JSONValue json = JSONParser.parseStrict(response.getText());
173         JSONArray array = json.isArray();
174         if (array != null) {
175             for (int i=0; i<array.size(); i++) {
176                 JSONObject o = array.get(i).isObject();
177                 if (o != null) {
178                     String contentType = unmarshallString(o, "content_type");
179                     if (o.containsKey("subdir") || (contentType != null && (contentType.startsWith("application/directory") || contentType.startsWith("application/folder")))) {
180                         Folder f = new Folder();
181                         f.populate(this, o, _owner, container);
182                         subfolders.add(f);
183                     }
184                     else {
185                         File file = new File();
186                         file.populate(this, o, _owner, container);
187                         files.add(file);
188                     }
189                 }
190             }
191         }
192     }
193
194     public void populate(Folder _parent, JSONObject o, String _owner, String aContainer) {
195         this.parent = _parent;
196         String path = null;
197         if (o.containsKey("subdir")) {
198             path = unmarshallString(o, "subdir");
199         }
200         else {
201             path = unmarshallString(o, "name");
202             lastModified = unmarshallDate(o, "last_modified");
203         }
204         //Strip the last / if exists in order to determine the name, but remember to put it back
205         boolean endsWithSlash = false;
206         if (path.endsWith("/")) {
207             path = path.substring(0, path.length() - 1);
208             endsWithSlash = true;
209         }
210         if (path.contains("/"))
211             name = path.substring(path.lastIndexOf("/") + 1, path.length()); //strip the prefix
212         else
213             name = path;
214         if (endsWithSlash) {
215                 path += "/";
216                 name += "/";
217         }
218         if (aContainer != null) {
219             container = aContainer;
220             prefix = path;
221         }
222         else {
223             container = name;
224             prefix = "";
225         }
226         this.owner = _owner;
227
228         inheritedPermissionsFrom = unmarshallString(o, "x_object_shared_by");
229         String rawPermissions = unmarshallString(o, "x_object_sharing");
230         if (rawPermissions != null)
231             parsePermissions(rawPermissions);
232     }
233
234     public static Folder createFromResponse(String owner, Response response, Folder result) {
235         Folder f = null;
236         if (result == null)
237             f = new Folder();
238         else
239             f = result;
240
241         f.populate(owner, response);
242         return f;
243     }
244
245     @Override
246     public boolean equals(Object other) {
247         if (other instanceof Folder) {
248             Folder o = (Folder) other;
249             return getUri().equals(o.getUri());
250         }
251         return false;
252     }
253
254     @Override
255     public int hashCode() {
256         return getUri().hashCode();
257     }
258
259     public Set<File> getFiles() {
260         return files;
261     }
262
263     public Folder getParent() {
264         return parent;
265     }
266
267     public String getUri() {
268         return "/" + container + (prefix.length() == 0 ? "" : "/" + prefix);
269     }
270
271     public boolean isContainer() {
272         return parent == null;
273     }
274
275     public void setContainer(String container) {
276         this.container = container;
277     }
278
279     public Set<String> getTags() {
280         return tags;
281     }
282
283     public String getInheritedPermissionsFrom() {
284         return inheritedPermissionsFrom;
285     }
286
287     public Map<String, Boolean[]> getPermissions() {
288         return permissions;
289     }
290
291     public String getOwner() {
292         return owner;
293     }
294
295     public boolean existChildrenPermissions() {
296         for (File f : files)
297             if (!f.getPermissions().isEmpty() && f.getInheritedPermissionsFrom() == null)
298                 return true;
299
300         for (Folder fo : subfolders)
301             if ((!fo.getPermissions().isEmpty() && fo.getInheritedPermissionsFrom() == null) || fo.existChildrenPermissions())
302                 return true;
303         return false;
304     }
305
306         public boolean isShared() {
307                 return !permissions.isEmpty();
308         }
309
310         /**
311          * I am THE trash
312          * 
313          * @return
314          */
315         public boolean isTrash() {
316                 return isContainer() && name.equals(Pithos.TRASH_CONTAINER);
317         }
318         
319         /**
320          * I am IN THE trash
321          * 
322          * @return
323          */
324         public boolean isInTrash() {
325                 return container.equals(Pithos.TRASH_CONTAINER);
326         }
327
328         public boolean isHome() {
329                 return isContainer() && name.equals(Pithos.HOME_CONTAINER);
330         }
331
332         public boolean contains(Folder folder) {
333                 for (Folder f : subfolders)
334                         if (f.equals(folder) || f.contains(folder))
335                                 return true;
336                 return false;
337         }
338 }