Fixed equals to consider owner apart from uri
[pithos-web-client] / src / gr / grnet / pithos / web / client / foldertree / Folder.java
1 /*
2  * Copyright 2011-2012 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 String owner;
84
85     private Map<String, Boolean[]> permissions = new HashMap<String, Boolean[]>();
86
87     private String inheritedPermissionsFrom;
88
89     public Folder() {};
90
91     public Folder(String name) {
92         this.name = name;
93     }
94     
95     public String getName() {
96         return name;
97     }
98
99     @Override
100         public Date getLastModified() {
101         return lastModified;
102     }
103
104     public long getBytesUsed() {
105         return bytesUsed;
106     }
107
108     public Set<Folder> getSubfolders() {
109         return subfolders;
110     }
111
112     public void setSubfolders(Set<Folder> subfolders) {
113         this.subfolders = subfolders;
114     }
115
116     public String getContainer() {
117         return container;
118     }
119
120     public String getPrefix() {
121         return prefix;
122     }
123
124     private void parsePermissions(String rawPermissions) {
125         String[] readwrite = rawPermissions.split(";");
126         for (String s : readwrite) {
127             String[] part = s.split("=");
128             String perm = part[0].trim();
129             String[] users = part[1].split(",");
130             for (String u : users) {
131                 String user = u.trim();
132                 Boolean[] userPerm = permissions.get(u);
133                 if (userPerm == null) {
134                     userPerm = new Boolean[2];
135                     permissions.put(user, userPerm);
136                 }
137                 if (perm.equals("read")) {
138                     userPerm[0] = Boolean.TRUE;
139                 }
140                 else if (perm.equals("write")) {
141                     userPerm[1] = Boolean.TRUE;
142                 }
143             }
144         }
145     }
146
147     public void populate(String _owner, Response response) {
148         this.owner = _owner;
149         String header = response.getHeader("Last-Modified");
150         if (header != null)
151                         try {
152                                 lastModified = DateTimeFormat.getFormat(PredefinedFormat.RFC_2822).parse(header);
153                         } catch (IllegalArgumentException e) {
154                                 GWT.log("Last-Modified will be set to null", e);
155                                 lastModified = null;
156                         }
157
158         header = response.getHeader("X-Container-Bytes-Used");
159         if (header != null && header.length() > 0)
160             bytesUsed = Long.valueOf(header);
161
162         String rawPermissions = response.getHeader("X-Object-Sharing");
163         if (rawPermissions != null && rawPermissions.length() > 0) {
164             parsePermissions(URL.decodePathSegment(rawPermissions));
165         }
166         
167         if (response.getText() == null || response.getText().isEmpty())
168                 return;
169         JSONValue json = JSONParser.parseStrict(response.getText());
170         JSONArray array = json.isArray();
171         if (array != null) {
172             subfolders.clear(); //This is necessary in case we update a pre-existing Folder so that stale subfolders won't show up
173             files.clear();
174             for (int i=0; i<array.size(); i++) {
175                 JSONObject o = array.get(i).isObject();
176                 if (o != null) {
177                     String contentType = unmarshallString(o, "content_type");
178                     if (o.containsKey("subdir") || (contentType != null && (contentType.startsWith("application/directory") || contentType.startsWith("application/folder")))) {
179                         Folder f = new Folder();
180                         f.populate(this, o, _owner, container);
181                         if (f.getName().length() > 0)
182                                 subfolders.add(f);
183                     }
184                     else {
185                         File file = new File();
186                         file.populate(this, o, _owner, container);
187                         if (file.getName().length() > 0)
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             if (path.endsWith("/")) { //Always true for "subdir"
201                 path = path.substring(0, path.length() - 1);
202             }
203             if (parent != null && parent.getPrefix().length() > 0)
204                 name = path.substring(parent.getPrefix().length() + 1);
205             else
206                 name = path;
207             if (name.equals("/"))
208                 name = "";
209         }
210         else {
211             path = unmarshallString(o, "name");
212             lastModified = unmarshallDate(o, "last_modified");
213             if (parent != null && parent.getPrefix().length() > 0)
214                 name = path.substring(parent.getPrefix().length() + 1);
215             else
216                 name = path;
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 owner.equals(o.getOwner()) && 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 String getInheritedPermissionsFrom() {
280         return inheritedPermissionsFrom;
281     }
282
283     public Map<String, Boolean[]> getPermissions() {
284         return permissions;
285     }
286
287     public String getOwner() {
288         return owner;
289     }
290
291         public boolean isShared() {
292                 return !permissions.isEmpty();
293         }
294
295         /**
296          * I am THE trash
297          * 
298          * @return
299          */
300         public boolean isTrash() {
301                 return isContainer() && name.equals(Pithos.TRASH_CONTAINER);
302         }
303         
304         /**
305          * I am IN THE trash
306          * 
307          * @return
308          */
309         public boolean isInTrash() {
310                 return container.equals(Pithos.TRASH_CONTAINER);
311         }
312
313         public boolean isHome() {
314                 return isContainer() && name.equals(Pithos.HOME_CONTAINER);
315         }
316
317         public boolean contains(Folder folder) {
318                 for (Folder f : subfolders)
319                         if (f.equals(folder) || f.contains(folder))
320                                 return true;
321                 return false;
322         }
323 }