Fixed problem with header name encoding in tags and groups
[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.http.client.URL;
49 import com.google.gwt.i18n.client.DateTimeFormat;
50 import com.google.gwt.i18n.client.DateTimeFormat.PredefinedFormat;
51 import com.google.gwt.json.client.JSONArray;
52 import com.google.gwt.json.client.JSONObject;
53 import com.google.gwt.json.client.JSONParser;
54 import com.google.gwt.json.client.JSONValue;
55
56 public class Folder extends Resource {
57     /*
58      * The name of the folder. If the folder is a container this is its name. If it is a virtual folder this is the
59      * last part of its path
60      */
61     private String name = null;
62
63     private Date lastModified = null;
64
65     private long bytesUsed = 0;
66
67     private Folder parent = null;
68     
69     private Set<Folder> subfolders = new LinkedHashSet<Folder>();
70     /*
71      * The name of the container that this folder belongs to. If this folder is container, this field equals name
72      */
73     private String container = null;
74
75     /*
76      * This is the full path of the folder (prefix is a misnomer but it was named so because this is used as a prefix=
77      * parameter in the request that fetches its children). If the folder is a cointainer this is empty string
78      */
79     private String prefix = "";
80
81     private Set<File> files = new LinkedHashSet<File>();
82
83     private Set<String> tags = new LinkedHashSet<String>();
84
85     private String owner;
86
87     private Map<String, Boolean[]> permissions = new HashMap<String, Boolean[]>();
88
89     private String inheritedPermissionsFrom;
90
91     public Folder() {};
92
93     public Folder(String name) {
94         this.name = name;
95     }
96     
97     public String getName() {
98         return name;
99     }
100
101     @Override
102         public Date getLastModified() {
103         return lastModified;
104     }
105
106     public long getBytesUsed() {
107         return bytesUsed;
108     }
109
110     public Set<Folder> getSubfolders() {
111         return subfolders;
112     }
113
114     public void setSubfolders(Set<Folder> subfolders) {
115         this.subfolders = subfolders;
116     }
117
118     public String getContainer() {
119         return container;
120     }
121
122     public String getPrefix() {
123         return prefix;
124     }
125
126     private void parsePermissions(String rawPermissions) {
127         String[] readwrite = rawPermissions.split(";");
128         for (String s : readwrite) {
129             String[] part = s.split("=");
130             String perm = part[0].trim();
131             String[] users = part[1].split(",");
132             for (String u : users) {
133                 String user = u.trim();
134                 Boolean[] userPerm = permissions.get(u);
135                 if (userPerm == null) {
136                     userPerm = new Boolean[2];
137                     permissions.put(user, userPerm);
138                 }
139                 if (perm.equals("read")) {
140                     userPerm[0] = Boolean.TRUE;
141                 }
142                 else if (perm.equals("write")) {
143                     userPerm[1] = Boolean.TRUE;
144                 }
145             }
146         }
147     }
148
149     public void populate(String _owner, Response response) {
150         this.owner = _owner;
151         String header = response.getHeader("Last-Modified");
152         if (header != null)
153                         try {
154                                 lastModified = DateTimeFormat.getFormat(PredefinedFormat.RFC_2822).parse(header);
155                         } catch (IllegalArgumentException e) {
156                                 GWT.log("Last-Modified will be set to null", e);
157                                 lastModified = null;
158                         }
159
160         header = response.getHeader("X-Container-Bytes-Used");
161         if (header != null && header.length() > 0)
162             bytesUsed = Long.valueOf(header);
163
164         header = response.getHeader("X-Container-Object-Meta");
165         if (header != null && header.length() > 0) {
166             for (String t : header.split(",")) {
167                 tags.add(URL.decodePathSegment(t.toLowerCase()).trim());
168             }
169         }
170
171         subfolders.clear(); //This is necessary in case we update a pre-existing Folder so that stale subfolders won't show up
172         files.clear();
173         JSONValue json = JSONParser.parseStrict(response.getText());
174         JSONArray array = json.isArray();
175         if (array != null) {
176             for (int i=0; i<array.size(); i++) {
177                 JSONObject o = array.get(i).isObject();
178                 if (o != null) {
179                     String contentType = unmarshallString(o, "content_type");
180                     if (o.containsKey("subdir") || (contentType != null && (contentType.startsWith("application/directory") || contentType.startsWith("application/folder")))) {
181                         Folder f = new Folder();
182                         f.populate(this, o, _owner, container);
183                         subfolders.add(f);
184                     }
185                     else {
186                         File file = new File();
187                         file.populate(this, o, _owner, container);
188                         files.add(file);
189                     }
190                 }
191             }
192         }
193     }
194
195     public void populate(Folder _parent, JSONObject o, String _owner, String aContainer) {
196         this.parent = _parent;
197         String path = null;
198         if (o.containsKey("subdir")) {
199             path = unmarshallString(o, "subdir");
200         }
201         else {
202             path = unmarshallString(o, "name");
203             lastModified = unmarshallDate(o, "last_modified");
204         }
205         //Strip the last / if exists in order to determine the name, but remember to put it back
206         boolean endsWithSlash = false;
207         if (path.endsWith("/")) {
208             path = path.substring(0, path.length() - 1);
209             endsWithSlash = true;
210         }
211         if (path.contains("/"))
212             name = path.substring(path.lastIndexOf("/") + 1, path.length()); //strip the prefix
213         else
214             name = path;
215         if (endsWithSlash) {
216                 path += "/";
217                 name += "/";
218         }
219         if (aContainer != null) {
220             container = aContainer;
221             prefix = path;
222         }
223         else {
224             container = name;
225             prefix = "";
226         }
227         this.owner = _owner;
228
229         inheritedPermissionsFrom = unmarshallString(o, "x_object_shared_by");
230         String rawPermissions = unmarshallString(o, "x_object_sharing");
231         if (rawPermissions != null)
232             parsePermissions(rawPermissions);
233     }
234
235     public static Folder createFromResponse(String owner, Response response, Folder result) {
236         Folder f = null;
237         if (result == null)
238             f = new Folder();
239         else
240             f = result;
241
242         f.populate(owner, response);
243         return f;
244     }
245
246     @Override
247     public boolean equals(Object other) {
248         if (other instanceof Folder) {
249             Folder o = (Folder) other;
250             return getUri().equals(o.getUri());
251         }
252         return false;
253     }
254
255     @Override
256     public int hashCode() {
257         return getUri().hashCode();
258     }
259
260     public Set<File> getFiles() {
261         return files;
262     }
263
264     public Folder getParent() {
265         return parent;
266     }
267
268     public String getUri() {
269         return "/" + container + (prefix.length() == 0 ? "" : "/" + prefix);
270     }
271
272     public boolean isContainer() {
273         return parent == null;
274     }
275
276     public void setContainer(String container) {
277         this.container = container;
278     }
279
280     public Set<String> getTags() {
281         return tags;
282     }
283
284     public String getInheritedPermissionsFrom() {
285         return inheritedPermissionsFrom;
286     }
287
288     public Map<String, Boolean[]> getPermissions() {
289         return permissions;
290     }
291
292     public String getOwner() {
293         return owner;
294     }
295
296     public boolean existChildrenPermissions() {
297         for (File f : files)
298             if (!f.getPermissions().isEmpty() && f.getInheritedPermissionsFrom() == null)
299                 return true;
300
301         for (Folder fo : subfolders)
302             if ((!fo.getPermissions().isEmpty() && fo.getInheritedPermissionsFrom() == null) || fo.existChildrenPermissions())
303                 return true;
304         return false;
305     }
306
307         public boolean isShared() {
308                 return !permissions.isEmpty();
309         }
310
311         /**
312          * I am THE trash
313          * 
314          * @return
315          */
316         public boolean isTrash() {
317                 return isContainer() && name.equals(Pithos.TRASH_CONTAINER);
318         }
319         
320         /**
321          * I am IN THE trash
322          * 
323          * @return
324          */
325         public boolean isInTrash() {
326                 return container.equals(Pithos.TRASH_CONTAINER);
327         }
328
329         public boolean isHome() {
330                 return isContainer() && name.equals(Pithos.HOME_CONTAINER);
331         }
332
333         public boolean contains(Folder folder) {
334                 for (Folder f : subfolders)
335                         if (f.equals(folder) || f.contains(folder))
336                                 return true;
337                 return false;
338         }
339 }