-
Notifications
You must be signed in to change notification settings - Fork 5
/
YanelServlet.java
3454 lines (3095 loc) · 178 KB
/
YanelServlet.java
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* See the NOTICE.txt file distributed with
* this work for additional information regarding copyright ownership.
* Wyona licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wyona.yanel.servlet;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.InputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.net.URL;
import java.util.Calendar;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.sax.TransformerHandler;
import javax.xml.transform.stream.StreamSource;
import org.wyona.commons.xml.XMLHelper;
import org.wyona.neutron.XMLExceptionV1;
import org.wyona.yanel.core.Environment;
import org.wyona.yanel.core.Path;
import org.wyona.yanel.core.Resource;
import org.wyona.yanel.core.ResourceConfiguration;
import org.wyona.yanel.core.ResourceNotFoundException;
import org.wyona.yanel.core.ResourceTypeIdentifier;
import org.wyona.yanel.core.ResourceTypeRegistry;
import org.wyona.yanel.core.StateOfView;
import org.wyona.yanel.core.ToolbarState;
import org.wyona.yanel.core.Yanel;
import org.wyona.yanel.core.api.attributes.AnnotatableV1;
import org.wyona.yanel.core.api.attributes.IntrospectableV1;
import org.wyona.yanel.core.api.attributes.DeletableV1;
import org.wyona.yanel.core.api.attributes.ModifiableV1;
import org.wyona.yanel.core.api.attributes.ModifiableV2;
import org.wyona.yanel.core.api.attributes.TranslatableV1;
import org.wyona.yanel.core.api.attributes.VersionableV1;
import org.wyona.yanel.core.api.attributes.VersionableV2;
import org.wyona.yanel.core.api.attributes.VersionableV3;
import org.wyona.yanel.core.api.attributes.ViewableV1;
import org.wyona.yanel.core.api.attributes.ViewableV2;
import org.wyona.yanel.core.api.attributes.WorkflowableV1;
import org.wyona.yanel.core.api.security.WebAuthenticator;
import org.wyona.yanel.core.attributes.versionable.RevisionInformation;
import org.wyona.yanel.core.attributes.viewable.View;
import org.wyona.yanel.core.attributes.viewable.ViewDescriptor;
import org.wyona.yanel.core.attributes.tracking.TrackingInformationV1;
import org.wyona.yanel.core.navigation.Node;
import org.wyona.yanel.core.navigation.Sitetree;
import org.wyona.yanel.core.serialization.SerializerFactory;
import org.wyona.yanel.core.source.SourceResolver;
import org.wyona.yanel.core.source.YanelStreamSource;
import org.wyona.yanel.core.transformation.I18nTransformer2;
import org.wyona.yanel.core.util.ConfigurationUtil;
import org.wyona.yanel.core.util.DateUtil;
import org.wyona.yanel.core.util.HttpServletRequestHelper;
import org.wyona.yanel.core.workflow.Transition;
import org.wyona.yanel.core.workflow.Workflow;
import org.wyona.yanel.core.workflow.WorkflowException;
import org.wyona.yanel.core.workflow.WorkflowHelper;
import org.wyona.yanel.core.map.Map;
import org.wyona.yanel.core.map.Realm;
import org.wyona.yanel.core.map.ReverseProxyConfig;
import org.wyona.yanel.core.util.ResourceAttributeHelper;
import org.wyona.yanel.impl.resources.BasicGenericExceptionHandlerResource;
import org.wyona.yanel.servlet.IdentityMap;
import org.wyona.yanel.servlet.communication.HttpRequest;
import org.wyona.yanel.servlet.communication.HttpResponse;
import org.wyona.yanel.servlet.security.impl.AutoLogin;
import org.wyona.security.core.api.Identity;
import org.wyona.security.core.api.Usecase;
import org.wyona.security.core.api.User;
import org.wyona.security.core.api.UserManager;
import org.apache.log4j.Logger;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.ThreadContext;
import org.apache.xalan.transformer.TransformerIdentityImpl;
import org.apache.xml.resolver.tools.CatalogResolver;
import org.apache.xml.serializer.Serializer;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.DefaultConfiguration;
import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
import org.apache.avalon.framework.configuration.DefaultConfigurationSerializer;
import org.apache.avalon.framework.configuration.MutableConfiguration;
import org.apache.commons.io.FilenameUtils;
//import org.apache.commons.io.IOUtils;
import org.apache.commons.io.output.ByteArrayOutputStream;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SimpleTrigger;
import org.quartz.Trigger;
import org.quartz.impl.StdSchedulerFactory;
/**
* Main entry point of Yanel webapp (see method 'service')
*/
public class YanelServlet extends HttpServlet {
private static org.apache.logging.log4j.Logger log = LogManager.getLogger(YanelServlet.class);
private static Logger logAccess = Logger.getLogger(AccessLog.CATEGORY);
private static Logger logDoNotTrack = Logger.getLogger("DoNotTrack"); // INFO: For debugging only!
private static Logger log404 = Logger.getLogger("404");
private Map map;
private Yanel yanelInstance;
private Sitetree sitetree;
private long MEMORY_GROWTH_THRESHOLD = 300;
private String defaultXsltInfoAndException;
private String xsltLoginScreenDefault;
private boolean displayMostRecentVersion = true;
public static final String MOBILE_KEY = "yanel.mobile";
public static final String IDENTITY_MAP_KEY = "identity-map";
private static final String TOOLBAR_USECASE = "toolbar"; //TODO is this the same as YanelAuthoringUI.TOOLBAR_KEY?
public static final String NAMESPACE = "http://www.wyona.org/yanel/1.0";
private static final String METHOD_PROPFIND = "PROPFIND";
private static final String METHOD_OPTIONS = "OPTIONS";
private static final String METHOD_GET = "GET";
private static final String METHOD_POST = "POST";
private static final String METHOD_PUT = "PUT";
private static final String METHOD_DELETE = "DELETE";
private static final String HTTP_REFERRER = "Referer"; // ah, misspellings, how I hate thee (http://en.wikipedia.org/wiki/Referer)!
private String sslPort = null;
private String toolbarMasterSwitch = "off";
private String reservedPrefix;
private String servletContextRealPath;
private int cacheExpires = 0;
private YanelHTMLUI yanelUI;
private boolean logAccessEnabled = false;
private boolean detectMobilePerRequest = false;
public static final String DEFAULT_ENCODING = "UTF-8";
public static final String YANEL_ACCESS_POLICY_USECASE = "yanel.policy";
public static final String YANEL_USECASE = "yanel.usecase";
public static final String YANEL_RESOURCE = "yanel.resource";
public static final String YANEL_RESOURCE_USECASE = YANEL_RESOURCE + ".usecase";
public static final String YANEL_RESOURCE_REVISION = YANEL_RESOURCE + ".revision";
public static final String YANEL_RESOURCE_WORKFLOW_TRANSITION = YANEL_RESOURCE + ".workflow.transition";
public static final String YANEL_RESOURCE_WORKFLOW_TRANSITION_OUTPUT = YANEL_RESOURCE_WORKFLOW_TRANSITION + ".output";
public static final String VIEW_ID_PARAM_NAME = "yanel.resource.viewid";
public static final String RESOURCE_META_ID_PARAM_NAME = "yanel.resource.meta";
public static final String RELEASE_LOCK = "release-lock";
private static final String CONTENT_TYPE_XHTML = "xhtml";
public static final String YANEL_LAST_ACCESS_ATTR = "_yanel-last-access";
private Scheduler scheduler;
private String[] mobileDevices;
private static String ACCESS_LOG_TAG_SEPARATOR;
private static final String REVISIONS_TAG_NAME = "revisions";
private static final String NO_REVISIONS_TAG_NAME = "no-revisions-yet";
private static final String EXCEPTION_TAG_NAME = "exception";
private static final String CAS_LOGOUT_REQUEST_PARAM_NAME = "logoutRequest";
/**
* @see javax.servlet.GenericServlet#init(ServletConfig)
*/
@Override
public void init(ServletConfig config) throws ServletException {
servletContextRealPath = config.getServletContext().getRealPath("/");
if (config.getInitParameter("memory.growth.threshold") != null) {
MEMORY_GROWTH_THRESHOLD = new Long(config.getInitParameter("memory.growth.threshold")).longValue();
}
defaultXsltInfoAndException = config.getInitParameter("exception-and-info-screen-xslt");
xsltLoginScreenDefault = config.getInitParameter("login-screen-xslt");
displayMostRecentVersion = new Boolean(config.getInitParameter("workflow.not-live.most-recent-version")).booleanValue();
try {
yanelInstance = Yanel.getInstance();
yanelInstance.init(); // TODO: Tell Yanel about alternative directory to look for configuration files, e.g. (File) getServletContext().getAttribute("javax.servlet.context.tempdir")
map = yanelInstance.getMapImpl("map");
sitetree = yanelInstance.getSitetreeImpl("repo-navigation");
sslPort = config.getInitParameter("ssl-port");
toolbarMasterSwitch = config.getInitParameter("toolbar-master-switch");
reservedPrefix = yanelInstance.getReservedPrefix();
String expires = config.getInitParameter("static-content-cache-expires");
if (expires != null) {
this.cacheExpires = Integer.parseInt(expires);
}
yanelUI = new YanelHTMLUI(map, reservedPrefix);
// TODO: Make this value configurable also per realm or per individual user!
logAccessEnabled = new Boolean(config.getInitParameter("log-access")).booleanValue();
String TAG_SEP_PARAM_NAME = "access-log-tag-separator";
if (config.getInitParameter(TAG_SEP_PARAM_NAME) != null) {
if (config.getInitParameter(TAG_SEP_PARAM_NAME).equals("SPACE")) { // Note that the leading and trailing space around the parameter value is trimmed, hence we denote the space sign by SPACE.
ACCESS_LOG_TAG_SEPARATOR = " ";
} else {
ACCESS_LOG_TAG_SEPARATOR = config.getInitParameter(TAG_SEP_PARAM_NAME);
}
} else {
ACCESS_LOG_TAG_SEPARATOR = ",";
log.warn("No access log tag separator parameter '" + TAG_SEP_PARAM_NAME + "' configured, hence use default: " + ACCESS_LOG_TAG_SEPARATOR);
}
// TODO: Make this value configurable also per realm or per individual user!
if (config.getInitParameter("detect-mobile-per-request") != null) {
detectMobilePerRequest = new Boolean(config.getInitParameter("detect-mobile-per-request")).booleanValue();
}
if (config.getInitParameter("mobile-devices") != null) {
mobileDevices = org.springframework.util.StringUtils.tokenizeToStringArray(config.getInitParameter("mobile-devices"), ",", true, true);
} else {
mobileDevices = new String[]{"iPhone", "Android"};
log.error("No mobile devices configured! Please make sure to update your web.xml configuration file accordingly. Fallback to hard-coded list: " + mobileDevices);
}
if (yanelInstance.isSchedulerEnabled()) {
try {
log.debug("Startup scheduler ...");
scheduler = StdSchedulerFactory.getDefaultScheduler();
Realm[] realms = yanelInstance.getRealmConfiguration().getRealms();
for (int i = 0; i < realms.length; i++) {
if (realms[i] instanceof org.wyona.yanel.core.map.RealmWithConfigurationExceptionImpl) {
String eMessage = ((org.wyona.yanel.core.map.RealmWithConfigurationExceptionImpl) realms[i]).getConfigurationException().getMessage();
log.error("Realm '" + realms[i].getID() + "' has thrown a configuration exception: " + eMessage);
} else {
String schedulerJobsPath = "/scheduler-jobs.xml";
if (realms[i].getRepository().existsNode(schedulerJobsPath)) {
log.debug("Scheduler jobs config found for realm: " + realms[i].getRepository().getID());
try {
// Get and filter scheduler config
InputStream istream = realms[i].getRepository().getNode(schedulerJobsPath).getInputStream();
log.debug("Filter scheduler configuration of realm '" + realms[i].getID() + "' by target environment '" + yanelInstance.getTargetEnvironment() + "'...");
istream = ConfigurationUtil.filterEnvironment(istream, yanelInstance.getTargetEnvironment());
Document filteredConfiguration = XMLHelper.readDocument(istream);
// INFO: Debug filtered scheduler configuration
if (log.isDebugEnabled()) {
org.wyona.yarep.core.Node filteredConfigDebugNode = null;
if (realms[i].getRepository().existsNode(schedulerJobsPath + ".DEBUG")) {
filteredConfigDebugNode = realms[i].getRepository().getNode(schedulerJobsPath + ".DEBUG");
} else {
filteredConfigDebugNode = org.wyona.yarep.util.YarepUtil.addNodes(realms[i].getRepository(), schedulerJobsPath + ".DEBUG", org.wyona.yarep.core.NodeType.RESOURCE);
}
XMLHelper.writeDocument(filteredConfiguration, filteredConfigDebugNode.getOutputStream());
}
// INFO: Run scheduler util
org.wyona.yanel.impl.scheduler.QuartzSchedulerUtil.schedule(scheduler, filteredConfiguration, realms[i]);
} catch(Exception e) {
log.error(e, e); // INFO: Log error, but otherwise ignore and keep going ...
}
}
}
}
/* TODO: Make global scheduler jobs configurable
String groupName = "yanel";
JobDetail jobDetail = new JobDetail("heartbeatJob", groupName, org.wyona.yanel.servlet.HeartbeatJob.class);
Date startDate = new Date();
Date endDate = null;
Trigger trigger = new SimpleTrigger("heartbeatTrigger", groupName, startDate, endDate, SimpleTrigger.REPEAT_INDEFINITELY, 60L * 1000L);
scheduler.scheduleJob(jobDetail, trigger);
*/
scheduler.start();
} catch(Exception e) {
log.error(e, e); // INFO: Let's be fault tolerant in case the scheduler should not start
}
} else {
log.info("The scheduler is currently disabled.");
}
} catch (Exception e) {
log.error(e.getMessage(), e);
throw new ServletException(e.getMessage(), e);
}
}
/**
* @see javax.servlet.http.HttpServlet#service(HttpServletRequest, HttpServletResponse)
*/
@Override
protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// NOTE: Do not add code outside the try-catch block, because otherwise exceptions won't be logged
try {
Runtime rt = Runtime.getRuntime();
long usedMBefore = getUsedMemory(rt);
//log.debug("Memory usage before request processed: " + usedMBefore);
ThreadContext.put("id", getFishTag(request));
//String httpAcceptMediaTypes = request.getHeader("Accept");
//String httpAcceptLanguage = request.getHeader("Accept-Language");
if (isCASLogoutRequest(request)) {
log.warn("DEBUG: CAS logout request received: " + request.getServletPath());
if (doCASLogout(request, response)) {
return;
} else {
log.error("Logout based on CAS request failed!");
}
return;
}
String yanelUsecase = request.getParameter(YANEL_USECASE);
if (yanelUsecase != null && yanelUsecase.equals("logout")) {
try {
log.debug("Disable auto login..."); // TODO: The cookie is not always deleted!
AutoLogin.disableAutoLogin(request, response, getRealm(request).getRepository());
} catch (Exception e) {
log.error("Exception while disabling auto login: " + e.getMessage(), e);
}
// INFO: Logout from Yanel
if (doLogout(request, response)) {
return;
} else {
log.error("Logout failed!");
}
} else if(yanelUsecase != null && yanelUsecase.equals("create")) { // TODO: Why does that not go through access control?
// INFO: Create a new resource
if(doCreate(request, response) != null) return;
}
// Check authorization and if authorization failed, then try to authenticate
if (doAccessControl(request, response) != null) {
// INFO: Either redirect (after successful authentication) or access denied (and response will contain the login screen)
return;
} else {
if (log.isDebugEnabled()) log.debug("Access granted: " + request.getServletPath());
}
// Check for requests re policies
String policyRequestPara = request.getParameter(YANEL_ACCESS_POLICY_USECASE);
if (policyRequestPara != null) {
doAccessPolicyRequest(request, response, 1);
return;
} else if (yanelUsecase != null && yanelUsecase.equals("policy.read")) {
doAccessPolicyRequest(request, response, 2);
return;
}
// Check for requests for global data
Resource resource = getResource(request, response);
String path = resource.getPath();
if (path.indexOf("/" + reservedPrefix + "/") == 0) {
getGlobalData(request, response);
return;
}
String value = request.getParameter(YANEL_RESOURCE_USECASE);
// Delete node
if (value != null && value.equals("delete")) {
handleDeleteUsecase(request, response);
return;
}
// INFO: Check if user agent is mobile device
doMobile(request);
// Delegate ...
String method = request.getMethod();
if (method.equals(METHOD_PROPFIND)) {
doPropfind(request, response);
} else if (method.equals(METHOD_GET)) {
doGet(request, response);
} else if (method.equals(METHOD_POST)) {
doPost(request, response);
} else if (method.equals(METHOD_PUT)) {
doPut(request, response);
} else if (method.equals(METHOD_DELETE)) {
doDelete(request, response);
} else if (method.equals(METHOD_OPTIONS)) {
doOptions(request, response);
} else {
log.error("No such method implemented: " + method);
response.sendError(HttpServletResponse.SC_NOT_IMPLEMENTED);
}
long usedMAfter = getUsedMemory(rt);
//log.debug("Memory usage after request processed: " + usedMAfter);
if ((usedMAfter - usedMBefore) > MEMORY_GROWTH_THRESHOLD) {
log.warn("Memory usage increased by '" + MEMORY_GROWTH_THRESHOLD + "' while request '" + getRequestURLQS(request, null, false) + "' was processed!");
}
} catch (ServletException e) {
log.error(e, e);
throw new ServletException(e.getMessage(), e);
} catch (IOException e) {
log.error(e, e);
throw new IOException(e.getMessage());
} finally {
ThreadContext.clear();
} // NOTE: This was our last chance to log an exception, hence do not add code outside the try-catch block
}
/**
* Get currently used memory
*/
private long getUsedMemory(Runtime rt) {
return (rt.totalMemory() - rt.freeMemory()) / 1024 / 1024;
}
/**
* @see javax.servlet.http.HttpServlet#doGet(HttpServletRequest, HttpServletResponse)
*/
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// INFO: Init session in case it does not exist yet
HttpSession session = request.getSession(true);
// INFO: Enable or disable toolbar
yanelUI.switchToolbar(request);
// INFO: Handle workflow transitions
String transition = request.getParameter(YANEL_RESOURCE_WORKFLOW_TRANSITION);
if (transition != null) {
executeWorkflowTransition(request,
response,
request.getParameter(YANEL_RESOURCE_REVISION),
transition);
return;
}
// INFO: Init resource
Resource resource = getResource(request, response);
// INFO: Check for requests refered by WebDAV
String yanelWebDAV = request.getParameter("yanel.webdav");
if(yanelWebDAV != null && yanelWebDAV.equals("propfind1")) {
log.info("WebDAV client (" + request.getHeader("User-Agent") + ") requests to \"edit\" a resource: " + resource.getRealm() + ", " + resource.getPath());
//return;
}
// INFO: Handle first specific Yanel usecase requests and then at the very end all other requests
String value = request.getParameter(YANEL_RESOURCE_USECASE);
try {
if (value != null && value.equals(RELEASE_LOCK)) {
log.warn("Try to release lock ...");
if (ResourceAttributeHelper.hasAttributeImplemented(resource, "Versionable", "2")) {
VersionableV2 versionable = (VersionableV2)resource;
String checkoutUserID = versionable.getCheckoutUserID();
Identity identity = getEnvironment(request, response).getIdentity();
String userID = identity.getUsername();
Usecase usecase = new Usecase(RELEASE_LOCK);
String path = resource.getPath();
if (checkoutUserID.equals(userID) || resource.getRealm().getPolicyManager().authorize(path, identity, usecase)) {
try {
versionable.cancelCheckout();
log.debug("Lock has been released.");
response.setStatus(HttpServletResponse.SC_OK);
response.setContentType("text/html" + "; charset=" + "UTF-8");
String backToRealm = org.wyona.yanel.core.util.PathUtil.backToRealm(resource.getPath());
StringBuilder sb = new StringBuilder("<html xmlns=\"http://www.w3.org/1999/xhtml\"><body>Lock has been released! back to <a href=\""+backToRealm + resource.getPath() +"\">page</a>.</body></html>");
PrintWriter w = response.getWriter();
w.print(sb);
return;
} catch (Exception e) {
throw new ServletException("Releasing the lock of <" + resource.getPath() + "> failed because of: " + e.getMessage(), e);
}
} else {
String eMessage = "Releasing the lock of '" + resource.getPath() + "' failed because";
if (checkoutUserID.equals(userID)) {
eMessage = " user '" + userID + "' has no right to release her/his own lock!";
} else {
eMessage = " checkout user '" + checkoutUserID + "' and session user '" + userID + "' are not the same and session user '" + userID + "' has no right to release the lock of the checkout user '" + checkoutUserID + "'!";
}
log.warn(eMessage);
throw new ServletException(eMessage);
}
} else {
throw new ServletException("Resource '" + resource.getPath() + "' is not VersionableV2!");
}
} else if (value != null && value.equals("roll-back")) {
log.debug("Roll back ...");
org.wyona.yanel.core.util.VersioningUtil.rollBack(resource, request.getParameter(YANEL_RESOURCE_REVISION), getIdentityFromRequest(request, map.getRealm(request.getServletPath())).getUsername());
// TODO: Send confirmation screen
getContent(request, response);
return;
} else {
//log.debug("Handle all other GET requests...");
getContent(request, response);
return;
}
} catch (Exception e) {
throw new ServletException(e.getMessage(), e);
}
}
/**
* Returns the mime-type according to the given file extension.
* Default is application/octet-stream.
* @param extension
* @return
*/
private static String guessMimeType(String extension) {
String ext = extension.toLowerCase();
if (ext.equals("html") || ext.equals("htm")) return "text/html";
if (ext.equals("css")) return "text/css";
if (ext.equals("txt")) return "text/plain";
if (ext.equals("js")) return "application/x-javascript";
if (ext.equals("jpg") || ext.equals("jpg")) return "image/jpeg";
if (ext.equals("gif")) return "image/gif";
if (ext.equals("pdf")) return "application/pdf";
if (ext.equals("zip")) return "application/zip";
if (ext.equals("htc")) return "text/x-component";
if (ext.equals("svg")) return "image/svg+xml";
// TODO: add more mime types
// TODO: and move to MimeTypeUtil
return "application/octet-stream"; // default
}
/**
* Generate response from view of resource
* @param request TODO
* @param response TODO
*/
private void getContent(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// INFO: Generate "yanel" document in order to collect information in case something should go wrong or some meta information should be requested
org.w3c.dom.Document doc = null;
try {
doc = getDocument(NAMESPACE, "yanel");
} catch (Exception e) {
throw new ServletException(e.getMessage(), e);
}
Element rootElement = doc.getDocumentElement();
rootElement.setAttribute("servlet-context-real-path", servletContextRealPath);
Element requestElement = (Element) rootElement.appendChild(doc.createElementNS(NAMESPACE, "request"));
requestElement.setAttributeNS(NAMESPACE, "uri", request.getRequestURI());
requestElement.setAttributeNS(NAMESPACE, "servlet-path", request.getServletPath());
HttpSession session = request.getSession(true);
Element sessionElement = (Element) rootElement.appendChild(doc.createElement("session"));
sessionElement.setAttribute("id", session.getId());
Enumeration<?> attrNames = session.getAttributeNames();
if (!attrNames.hasMoreElements()) {
Element sessionNoAttributesElement = (Element) sessionElement.appendChild(doc.createElement("no-attributes"));
}
while (attrNames.hasMoreElements()) {
String name = (String)attrNames.nextElement();
String value = session.getAttribute(name).toString();
Element sessionAttributeElement = (Element) sessionElement.appendChild(doc.createElement("attribute"));
sessionAttributeElement.setAttribute("name", name);
sessionAttributeElement.appendChild(doc.createTextNode(value));
}
String usecase = request.getParameter(YANEL_RESOURCE_USECASE);
Resource res = null;
TrackingInformationV1 trackInfo = null;
long lastModified = -1;
long size = -1;
// START first try
View view = null;
try {
Environment environment = getEnvironment(request, response);
res = getResource(request, response);
if (res != null) {
if (isTrackable(res)) {
//log.debug("Do track: " + res.getPath());
trackInfo = new TrackingInformationV1();
((org.wyona.yanel.core.api.attributes.TrackableV1) res).doTrack(trackInfo);
//} else {
// log.debug("Resource '" + res.getPath() + "' is not trackable.");
}
// START introspection generation
if (usecase != null && usecase.equals("introspection")) {
sendIntrospectionAsResponse(res, doc, rootElement, request, response);
return;
}
// END introspection generation
Element resourceElement = getResourceMetaData(res, doc, rootElement);
Element viewElement = (Element) resourceElement.appendChild(doc.createElement("view"));
if (ResourceAttributeHelper.hasAttributeImplemented(res, "Viewable", "1")) {
if (log.isDebugEnabled()) log.debug("Resource is viewable V1");
viewElement.setAttributeNS(NAMESPACE, "version", "1");
appendViewDescriptors(doc, viewElement, ((ViewableV1) res).getViewDescriptors());
String viewId = getViewID(request);
try {
view = ((ViewableV1) res).getView(request, viewId);
} catch (org.wyona.yarep.core.NoSuchNodeException e) {
String message = e.getMessage();
log.error(message, e);
do404(request, response, doc, message);
return;
} catch (Exception e) {
String message = e.getMessage();
log.error(message, e);
Element exceptionElement = (Element) rootElement.appendChild(doc.createElementNS(NAMESPACE, EXCEPTION_TAG_NAME));
exceptionElement.appendChild(doc.createTextNode(message));
exceptionElement.setAttributeNS(NAMESPACE, "status", "500");
response.setStatus(javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
setYanelOutput(request, response, doc);
return;
}
} else if (ResourceAttributeHelper.hasAttributeImplemented(res, "Viewable", "2")) {
if (log.isDebugEnabled()) log.debug("Resource '" + res.getPath() + "' is viewable V2");
viewElement.setAttributeNS(NAMESPACE, "version", "2");
appendViewDescriptors(doc, viewElement, ((ViewableV2) res).getViewDescriptors());
if (!((ViewableV2) res).exists()) {
log.warn("ViewableV2 resource '" + res.getPath() + "' does not seem to exist, whereas this resource might not implement exists() properly. Yanel does not generate a 404 response for backwards compatibility reasons, because there are various ViewableV2 resources which do not implement exists() properly. As a workaround one might want to use the exists() method within the getView(String) method and throw a ResourceNotFoundException instead.");
//do404(request, response, doc, res.getPath());
//return;
}
try {
size = ((ViewableV2) res).getSize();
Element sizeElement = (Element) resourceElement.appendChild(doc.createElement("size"));
sizeElement.appendChild(doc.createTextNode(String.valueOf(size)));
} catch(ResourceNotFoundException e) {
log.error(e, e); // INFO: Let's be fault tolerant such that a 404 can be handled more gracefully further down
}
String viewId = getViewID(request);
try {
String revisionName = request.getParameter(YANEL_RESOURCE_REVISION);
// NOTE: Check also if usecase is not roll-back, because roll-back is also using the yanel.resource.revision
if (revisionName != null && !isRollBack(request)) {
if (ResourceAttributeHelper.hasAttributeImplemented(res, "Versionable", "2")) {
view = ((VersionableV2) res).getView(viewId, revisionName);
} else {
log.warn("Resource '" + res.getPath() + "' has not VersionableV2 implemented, hence we cannot generate view for revision: " + revisionName);
view = ((ViewableV2) res).getView(viewId);
}
} else if (environment.getStateOfView().equals(StateOfView.LIVE) && ResourceAttributeHelper.hasAttributeImplemented(res, "Workflowable", "1") && WorkflowHelper.getWorkflow(res) != null) { // TODO: Instead using the WorkflowHelper the Workflowable interface should have a method to check if the resource actually has a workflow assigned, see http://lists.wyona.org/pipermail/yanel-development/2009-June/003709.html
// TODO: Check if resource actually exists (see the exist problem above), because even it doesn't exist, the workflowable interfaces can return something although it doesn't really make sense. For example if a resource type is workflowable, but it has no workflow associated with it, then WorkflowHelper.isLive will nevertheless return true, whereas WorkflowHelper.getLiveView will throw an exception!
if (!((ViewableV2) res).exists()) {
log.warn("No such ViewableV2 resource: " + res.getPath());
log.warn("TODO: It seems like many ViewableV2 resources are not implementing exists() properly!");
do404(request, response, doc, res.getPath());
return;
}
WorkflowableV1 workflowable = (WorkflowableV1)res;
if (workflowable.isLive()) {
view = workflowable.getLiveView(viewId);
} else {
String message = "The viewable (V2) resource '" + res.getPath() + "' is WorkflowableV1, but has not been published yet.";
log.warn(message);
// TODO: Make this configurable per resource (or rather workflowable interface) or per realm?!
if (displayMostRecentVersion) {
// INFO: Because of backwards compatibility the default should display the most recent version
log.warn("Instead a live/published version, the most recent version will be displayed!");
view = ((ViewableV2) res).getView(viewId);
} else {
log.warn("Instead a live/published version, a 404 will be displayed!");
// TODO: Instead a 404 one might want to show a different kind of screen
do404(request, response, doc, message);
return;
}
}
} else {
view = ((ViewableV2) res).getView(viewId);
}
} catch (org.wyona.yarep.core.NoSuchNodeException e) {
String message = e.getMessage();
log.warn(message, e);
do404(request, response, doc, message);
return;
} catch (ResourceNotFoundException e) {
String message = e.getMessage();
log.warn(message, e);
do404(request, response, doc, message);
return;
} catch(Exception e) {
log.error(e, e);
handleException(request, response, e);
return;
}
} else { // NO Viewable interface implemented!
String message = res.getClass().getName() + " is not viewable! (" + res.getPath() + ", " + res.getRealm() + ")";
log.error(message);
Element noViewElement = (Element) resourceElement.appendChild(doc.createElement("not-viewable"));
noViewElement.appendChild(doc.createTextNode(res.getClass().getName() + " is not viewable!"));
Element exceptionElement = (Element) rootElement.appendChild(doc.createElementNS(NAMESPACE, EXCEPTION_TAG_NAME));
exceptionElement.appendChild(doc.createTextNode(message));
exceptionElement.setAttributeNS(NAMESPACE, "status", "501");
response.setStatus(javax.servlet.http.HttpServletResponse.SC_NOT_IMPLEMENTED);
setYanelOutput(request, response, doc);
return;
}
if (ResourceAttributeHelper.hasAttributeImplemented(res, "Modifiable", "2")) {
lastModified = ((ModifiableV2) res).getLastModified();
Element lastModifiedElement = (Element) resourceElement.appendChild(doc.createElement("last-modified"));
lastModifiedElement.appendChild(doc.createTextNode(new Date(lastModified).toString()));
} else {
Element noLastModifiedElement = (Element) resourceElement.appendChild(doc.createElement("no-last-modified"));
}
// INFO: Get the revisions, but only in the meta usecase (because of performance reasons)
if (request.getParameter(RESOURCE_META_ID_PARAM_NAME) != null) {
appendRevisionsAndWorkflow(doc, resourceElement, res, request);
}
if (ResourceAttributeHelper.hasAttributeImplemented(res, "Translatable", "1")) {
TranslatableV1 translatable = ((TranslatableV1) res);
Element translationsElement = (Element) resourceElement.appendChild(doc.createElement("translations"));
String[] languages = translatable.getLanguages();
for (int i=0; i<languages.length; i++) {
Element translationElement = (Element) translationsElement.appendChild(doc.createElement("translation"));
translationElement.setAttribute("language", languages[i]);
String path = translatable.getTranslation(languages[i]).getPath();
translationElement.setAttribute("path", path);
}
}
if (usecase != null && usecase.equals("checkout")) {
if(log.isDebugEnabled()) log.debug("Checkout data ...");
if (ResourceAttributeHelper.hasAttributeImplemented(res, "Versionable", "2")) {
// NOTE: The code below will throw an exception if the document is checked out already by another user.
String userID = environment.getIdentity().getUsername();
VersionableV2 versionable = (VersionableV2)res;
if (versionable.isCheckedOut()) {
String checkoutUserID = versionable.getCheckoutUserID();
if (checkoutUserID.equals(userID)) {
log.warn("Resource " + res.getPath() + " is already checked out by this user: " + checkoutUserID);
} else {
if (isClientSupportingNeutron(request)) {
String eMessage = "Resource '" + res.getPath() + "' is already checked out by another user: " + checkoutUserID;
response.setContentType("application/xml");
response.setStatus(javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
// TODO: Checkout date and break-lock (optional)
response.getWriter().print(XMLExceptionV1.getCheckoutException(eMessage, res.getPath(), checkoutUserID, null));
return;
} else {
throw new Exception("Resource '" + res.getPath() + "' is already checked out by another user: " + checkoutUserID);
}
}
} else {
versionable.checkout(userID);
}
} else {
log.warn("Acquire lock has not been implemented yet ...!");
// acquireLock();
}
}
} else {
Element resourceIsNullElement = (Element) rootElement.appendChild(doc.createElement("resource-is-null"));
}
} catch (org.wyona.yarep.core.NoSuchNodeException e) {
String message = e.getMessage();
log.warn(message, e);
do404(request, response, doc, message);
return;
} catch (org.wyona.yanel.core.ResourceNotFoundException e) {
String message = e.getMessage();
log.warn(message, e);
do404(request, response, doc, message);
return;
} catch (Exception e) {
log.error(e, e);
handleException(request, response, e);
return;
}
// END first try
String meta = request.getParameter(RESOURCE_META_ID_PARAM_NAME);
if (meta != null) {
if (meta.length() > 0) {
if (meta.equals("annotations")) {
log.debug("Remove everything from the page meta document except the annotations");
cleanMetaDoc(doc);
appendAnnotations(doc, res);
appendTrackingInformation(doc, trackInfo);
} else {
log.warn("TODO: Stripping everything from page meta document but, '" + meta + "' not supported!");
}
} else {
log.debug("Show all meta");
appendAnnotations(doc, res);
appendTrackingInformation(doc, trackInfo);
}
response.setStatus(javax.servlet.http.HttpServletResponse.SC_OK);
setYanelOutput(request, response, doc);
return;
}
if (view != null) {
if (generateResponse(view, res, request, response, -1, doc, size, lastModified, trackInfo) != null) {
//log.debug("Response has been generated successfully :-)");
return;
} else {
log.warn("No response has been generated!");
}
} else {
String message = "View is null!";
Element exceptionElement = (Element) rootElement.appendChild(doc.createElementNS(NAMESPACE, EXCEPTION_TAG_NAME));
exceptionElement.appendChild(doc.createTextNode(message));
}
response.setStatus(javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
setYanelOutput(request, response, doc);
return;
}
/**
* @see javax.servlet.http.HttpServlet#doPost(HttpServletRequest, HttpServletResponse)
*/
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
String transition = request.getParameter(YANEL_RESOURCE_WORKFLOW_TRANSITION);
if (transition != null) {
executeWorkflowTransition(request,
response,
request.getParameter(YANEL_RESOURCE_REVISION),
transition);
return;
}
String value = request.getParameter(YANEL_RESOURCE_USECASE);
if (value != null && value.equals("save")) {
log.debug("Save data ...");
save(request, response, false);
return;
} else if (value != null && value.equals("checkin")) {
log.debug("Checkin data ...");
save(request, response, true);
log.warn("Release lock has not been implemented yet ...");
// releaseLock();
return;
} else {
log.info("No parameter " + YANEL_RESOURCE_USECASE + "!");
String contentType = request.getContentType();
// TODO: Check for type (see section 9.2 of APP spec (e.g. draft 16)
if (contentType != null && contentType.indexOf("application/atom+xml") >= 0) {
InputStream in = intercept(request.getInputStream());
// Create new Atom entry
try {
String atomEntryUniversalName = "<{http://www.wyona.org/yanel/resource/1.0}atom-entry/>";
Realm realm = yanelInstance.getMap().getRealm(request.getServletPath());
String newEntryPath = yanelInstance.getMap().getPath(realm, request.getServletPath() + "/" + new Date().getTime() + ".xml");
log.debug("Realm and Path of new Atom entry: " + realm + " " + newEntryPath);
Resource atomEntryResource = yanelInstance.getResourceManager().getResource(getEnvironment(request, response), realm, newEntryPath, new ResourceTypeRegistry().getResourceTypeDefinition(atomEntryUniversalName), new ResourceTypeIdentifier(atomEntryUniversalName, null));
((ModifiableV2)atomEntryResource).write(in);
byte buffer[] = new byte[8192];
int bytesRead;
InputStream resourceIn = ((ModifiableV2)atomEntryResource).getInputStream();
OutputStream responseOut = response.getOutputStream();
while ((bytesRead = resourceIn.read(buffer)) != -1) {
responseOut.write(buffer, 0, bytesRead);
}
resourceIn.close();
//responseOut.close();
// TODO: Fix Location ...
response.setHeader("Location", "http://ulysses.wyona.org" + newEntryPath);
response.setStatus(javax.servlet.http.HttpServletResponse.SC_CREATED);
return;
} catch (Exception e) {
throw new ServletException(e.getMessage(), e);
}
}
// Enable or disable toolbar
yanelUI.switchToolbar(request);
getContent(request, response);
}
}
/**
* Perform the given transition on the indicated revision.
* @param request TODO
* @param response TODO
* @param revision TODO
* @param transitionID Workflow transition ID
* @throws ServletException
* @throws IOException
*/
private void executeWorkflowTransition(HttpServletRequest request,
HttpServletResponse response,
String revision,
String transitionID)
throws ServletException, IOException {
Resource resource = getResource(request, response);
if (ResourceAttributeHelper.hasAttributeImplemented(resource, "Workflowable", "1")) {
WorkflowableV1 workflowable = (WorkflowableV1)resource;
try {
String outputFormat = request.getParameter(YANEL_RESOURCE_WORKFLOW_TRANSITION_OUTPUT);
StringBuilder sb = null;
workflowable.doTransition(transitionID, revision);
response.setStatus(javax.servlet.http.HttpServletResponse.SC_OK);
if (outputFormat != null && CONTENT_TYPE_XHTML.equals(outputFormat.toLowerCase())) {
Workflow workflow = WorkflowHelper.getWorkflow(resource);
Transition transition = workflow.getTransition(transitionID);
String description = transitionID;
try {
description = transition.getDescription(getLanguage(request, "en"));
} catch(Exception e) {
log.error(e, e);
}
response.setContentType("text/html; charset=" + DEFAULT_ENCODING);
sb = new StringBuilder("<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><meta http-equiv=\"refresh\" content=\"3;URL='"
+ request.getHeader(HTTP_REFERRER)
+ "'\"></head><body><div style=\"text-align: center; font-family: sans-serif;\"><p> <br/> <br/>The workflow transition <strong style=\"background-color: #dff0d8;\"> "
+ description
+ " </strong> has been performed.</p><p>Return to <a href=\""
+ request.getHeader(HTTP_REFERRER)
+ "\">the page</a>.</p></div></body></html>");
} else {
log.warn("DEBUG: No output format query string parameter '" + YANEL_RESOURCE_WORKFLOW_TRANSITION_OUTPUT + "' has been specified.");
response.setContentType("application/xml; charset=" + DEFAULT_ENCODING);
sb = new StringBuilder("<?xml version=\"1.0\"?>");
sb.append(workflowable.getWorkflowIntrospection());
}
PrintWriter w = response.getWriter();
w.print(sb);
} catch (WorkflowException e) {
log.error(e, e);
response.setContentType("application/xml; charset=" + DEFAULT_ENCODING);
response.setStatus(javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
PrintWriter w = response.getWriter();
w.print(getWorkflowException(e.getMessage()));
return;
}
} else {
log.warn("Resource not workflowable: " + resource.getPath());
}
}
/**