-
Notifications
You must be signed in to change notification settings - Fork 13
/
BlogCode.xml
1249 lines (1244 loc) · 55.8 KB
/
BlogCode.xml
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
<?xml version="1.0" encoding="UTF-8"?>
<!--
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-->
<xwikidoc version="1.3" reference="Blog.BlogCode" locale="">
<web>Blog</web>
<name>BlogCode</name>
<language/>
<defaultLanguage/>
<translation>0</translation>
<creator>xwiki:XWiki.Admin</creator>
<creationDate>1373016402000</creationDate>
<parent>Blog.WebHome</parent>
<author>xwiki:XWiki.Admin</author>
<contentAuthor>xwiki:XWiki.Admin</contentAuthor>
<date>1373018317000</date>
<contentUpdateDate>1373018155000</contentUpdateDate>
<version>1.1</version>
<title>Macros for the Blog application</title>
<comment/>
<minorEdit>false</minorEdit>
<syntaxId>xwiki/2.1</syntaxId>
<hidden>true</hidden>
<content>{{include reference="Blog.BlogParameters"/}}
{{velocity output="false"}}
##
##
##
## Import the blog skin and javascripts.
$!xwiki.ssx.use($blogStyleDocumentName)##
$!xwiki.jsx.use($blogScriptsDocumentName)##
##
## import the hierarchy for the path the blog post footer (in displayEntryBlogLocation)
#template('hierarchy_macros.vm')##
##
##
#**
* Prints a blog. This is the main macro used in the BlogSheet.
*
* @param blogDoc the XDocument holding the blog definition object.
*###
#macro(printBlog $blogDoc)
{{include reference='Blog.CreatePost'/}}
## Use the blogPostList macro to display the blogposts
## The blogPostList is used only in case of 'all' or 'paged' blog display type because the blogPostList macro
## do not support FTM the monthly and weekly blog display types
#getBlogDisplayType($blogDoc $displayType)
#if ($displayType == 'weekly' || $displayType == 'monthly')
#getBlogEntries($blogDoc $entries)
#displayBlog($entries 'index' true true)
#displayNavigationLinks($blogDoc)
#else
#getBlogDisplayType($blogDoc $displayType)
#set ($paginated = 'no')
#if ($displayType == 'paginated')
#set ($paginated = 'yes')
#end
#getBlogPostsLayout($blogDoc $postsLayout)
(% class="hfeed index" %)((({{blogpostlist blog="$blogDoc.fullName.replaceAll('~', '~~').replaceAll('"', '~"')" paginated="$paginated" layout="$!postsLayout.replaceAll('~', '~~').replaceAll('"', '~"')" /}})))
#end
#end
##
##
##
#**
* Shows blog information. In view mode, the description is printed. In edit mode, allows changing blog settings: title,
* description, blog type (global or in-space), index display type (fixed size pagination, weekly index, monthly index,
* all entries).
*
* @param blogDoc The blog document. It should contain a <tt>Blog.BlogClass</tt> object.
*###
#macro(showBlogInfo $blogDoc)
#if($blogDoc.getObject($blogClassname))
## Keep testing for inline action for backward compatibility with older blogs.
#if($xcontext.action == 'edit' || $xcontext.action == 'inline')
#macro(displayProperty $blogDoc $propname)
; #displayPropName($xwiki.getClass($blogClassname).get($propname)):
: $blogDoc.display($propname)
#end
#displayProperty($blogDoc 'title')
#displayProperty($blogDoc 'description')
#displayProperty($blogDoc 'displayType')
#displayProperty($blogDoc 'itemsPerPage')
#displayProperty($blogDoc 'postsLayout')
#displayProperty($blogDoc 'postsLayoutParameters')
#else
$blogDoc.display('description')
#end
#elseif($doc.fullName == $blogSheet)
= $services.localization.render('blog.code.blogsheet') =
{{translation key='blog.code.sheetexplanation'/}}
#else
{{warning}}{{translation key='blog.code.notblog'/}}{{/warning}}
#end
#end
##
##
##
#**
* Retrieve the blog document, which usually is either <tt>&lt;Space&gt;.WebHome</tt> for whole-spaces blogs, or
* <tt>&lt;Space&gt;.Blog</tt> for in-space blogs. If none of these documents contains a blog object, then the first
* (alphabetically) document in the target space that contains one is returned. Finally, if no document in the current
* space contains a blog object, then <tt>Blog.WebHome</tt> is returned as the default blog.
*
* @param space A <tt>String</tt>, the name of the space where to search.
* @param blogDoc The resulting XDocument.
*###
#macro(getBlogDocument $space $blogDoc)
#set ($result = $NULL)
## Check if the current space has a WebPreferences page that contains a Blog.EnablePanelsConfigurationClass object.
## It is possible to display a blog's panels info in a page that is not inside a blog and in that case we need to
## identify the right blog based on a configuration object in a WebPreferences page.
#set ($spaceReference = $services.model.resolveSpace($space))
#set ($preferencesDocRef = $services.model.createDocumentReference('WebPreferences', $spaceReference))
#set ($preferencesDoc = $xwiki.getDocument($preferencesDocRef))
#set ($preferencesObj = $preferencesDoc.getObject('Blog.EnablePanelsConfigurationClass'))
#if ($preferencesObj)
#set ($result = $xwiki.getDocument( $preferencesObj.getValue('blog')))
#end
## If no special case occurs (like the previous one), identify a blog by checking the current location from its hierarchy.
#if ("$!result" == '')
## First, try the Space.WebHome, for a whole-space blog
#set($result = $xwiki.getDocument("${space}.WebHome"))
#if(!$result.getObject($blogClassname))
## Second, try the Space.Blog document
#set($result = $xwiki.getDocument("${space}.Blog"))
#if(!$result.getObject($blogClassname))
## Third, try searching for a blog document in the current space
## Prevent the query fail when the space contains dots '.'
#set($blogDocs = $services.query.hql(", BaseObject obj where doc.space = :space and obj.name = doc.fullName and obj.className = '$blogClassname' order by doc.name").setLimit(1).setOffset(0).bindValue('space', $space).execute())
#if($blogDocs.size() > 0)
#set($result = $xwiki.getDocument($blogDocs.get(0)))
#else
## Fourth, try searching for a blog document that have the its 'postsLocation' set to the current space
#set($blogDocs = $services.query.hql(", BaseObject obj, StringProperty as postsLocationProp where obj.name = doc.fullName and obj.className = '$blogClassname' and obj.id=postsLocationProp.id.id and postsLocationProp.id.name='postsLocation' and postsLocationProp.value=:postsLocation order by doc.name").setLimit(1).setOffset(0).bindValue('postsLocation', $space).execute())
#if($blogDocs.size() > 0)
#set($result = $xwiki.getDocument($blogDocs.get(0)))
#else
## Last, fallback to Blog.WebHome, the default blog
#set($result = $xwiki.getDocument('Blog.WebHome'))
#end
#end
#end
#end
#end
#set ($blogDoc = $NULL)
#setVariable ("$blogDoc" $result)
#end
##
##
##
#**
* Retrieve the blog title.
*
* @param blogDoc The blog document. It should contain a <tt>Blog.BlogClass<tt> object with the <tt>title</tt> property set.
* @param title The resulting title.
*###
#macro(getBlogTitle $blogDoc $title)
## Titles can contain velocity code (most commonly translations), so we should evaluate them.
#set ($title = $NULL)
#setVariable ("$title" $!blogDoc.displayTitle)
#end
##
##
##
#**
* Retrieve the blog description.
*
* @param blogDoc The blog document. It should contain a <tt>Blog.BlogClass</tt> object with the <tt>description</tt>
* property set.
* @param description The resulting description.
*###
#macro(getBlogDescription $blogDoc $description)
#getBlogProperty($blogDoc 'description' '' $result)
#set ($description = $NULL)
#setVariable ("$description" $result)
#end
##
##
##
#**
* Retrieves a list of entries to be displayed. The entries are either part of the blog's space, or have the blog
* document set as a parent. The number and range of entries returned (from all those belonging to this blog) depends on
* the blog display type: paginated (fixed number of entries), weekly (all entries in a week), monthly (all entries in a
* month), or all.
*
* @param blogDoc The blog document. It should contain a <tt>Blog.BlogClass</tt> object.
* @param entries The resulting list of entries to display, a list of XDocument names.
*###
#macro(getBlogEntries $blogDoc $entries)
#if (!$entries)
#setVariable ("$entries" [])
#end
#getAllBlogPostsQuery($query)
#isDefaultBlog($blogDoc $isDefault)
#set($queryParams = {})
#if ($isDefault)
#getCategoryAllBlogPostsQuery($query)
#set($query = "${query} and (doc.creator = :creator or (isPublished.value = 1 and hidden.value = 0)) and (doc.space = :space or catList like :catList escape '!')")
#set($discard = $queryParams.put('creator', $xcontext.user))
#set($discard = $queryParams.put('space', $blogDoc.space))
#set($sanitizedBlogSpace = $blogDoc.space.replaceAll('([%_!])', '!$1').concat('.%'))
#set($discard = $queryParams.put('catList', $sanitizedBlogSpace))
#else
#set($query = "${query} and (doc.space = :space or doc.parent = :parent)")
#getBlogPostsLocation($blogDoc.space $blogPostsLocation)
#set($discard = $queryParams.put('space', $blogPostsLocation))
#set($discard = $queryParams.put('parent', $blogDoc.space))
#end
#getBlogDisplayType($blogDoc $displayType)
#if($displayType == 'weekly')
#getWeeklyBlogEntries($blogDoc $query $entries $queryParams)
#elseif($displayType == 'monthly')
#getMonthlyBlogEntries($blogDoc $query $entries $queryParams)
#elseif($displayType == 'all')
#getAllBlogEntries($blogDoc $query $entries $queryParams)
#else
#getPagedBlogEntries($blogDoc $query $entries $queryParams)
#end
#end
##
##
##
#**
* Retrieves a list of entries to be displayed. The entries are taken from a "page" of the blog, a sequence of documents
* defined by the request parameters <tt>ipp</tt> (items per page) and <tt>page</tt> (the current page). Initially the
* first page is displayed, with the number of entries defined in the blog object in the <tt>itemsPerPage</tt> property
* (10 if not defined).
*
* @param blogDoc The blog document. It should contain a <tt>Blog.BlogClass</tt> object.
* @param query The base query for selecting entries. Apart from the base query that selects entries, it can further be
* refined to restrict to a given space, or to a given search criteria, etc.
* @param entries The resulting list of entries to display, a list of XDocument names.
* @param queryParams The parameters to bind with the query.
*###
#macro(getPagedBlogEntries $blogDoc $query $entries $queryParams)
#if (!$entries)
#setVariable ("$entries" [])
#end
#set($countQueryObj = $services.query.hql($query).addFilter("unique"))
#set($queryObj = $services.query.hql("${query} order by publishDate.value desc"))
#bindQueryParameters($countQueryObj $queryParams)
#bindQueryParameters($queryObj $queryParams)
#set($totalEntries = $countQueryObj.count())
#getBlogProperty($blogDoc 'itemsPerPage' '10' $defaultItemsPerPage)
#set($defaultItemsPerPage = $numbertool.toNumber($defaultItemsPerPage).intValue())
## This macro is defined in the default macros.vm library. It also sets $itemsPerPage and $startAt.
#preparePagedViewParams($totalEntries $defaultItemsPerPage)
#set($discard = $entries.addAll($queryObj.setLimit($itemsPerPage).setOffset($startAt).addFilter("unique").execute()))
#end
##
##
##
#**
* Retrieves a list of entries to be displayed. The entries are taken from a week of the blog. The target week is
* defined by the request parameters <tt>week</tt> (the week number in the year, from 1 to 52) and <tt>year</tt> (4
* digit year). Initially the current week is displayed.
*
* @param blogDoc The blog document. It should contain a <tt>Blog.BlogClass</tt> object.
* @param query The base query for selecting entries. Apart from the base query that selects entries, it can further be
* refined to restrict to a given space, or to a given search criteria, etc.
* @param entries The resulting list of entries to display, a list of XDocument names.
* @param queryParams The parameters to bind with the query.
*###
#macro(getWeeklyBlogEntries $blogDoc $query $entries $queryParams)
#if (!$entries)
#setVariable ("$entries" [])
#end
#getRequestedWeek($weekDate)
#set($dateFormatter = $xwiki.jodatime.getDateTimeFormatterForPattern('yyyy-MM-dd'))
#set($minDay = $dateFormatter.print($weekDate.toMutableDateTime().weekOfWeekyear().roundFloor()))
#set($maxDay = $dateFormatter.print($weekDate.toMutableDateTime().weekOfWeekyear().roundCeiling()))
#set($query = "${query} and publishDate.value >= '$minDay' and publishDate.value < '$maxDay'")
#set($countQueryObj = $services.query.hql($query).addFilter("unique"))
#set($queryObj = $services.query.hql("${query} order by publishDate.value desc").addFilter("unique"))
#bindQueryParameters($countQueryObj $queryParams)
#bindQueryParameters($queryObj $queryParams)
#set($totalEntries = $countQueryObj.count())
#set($discard = $entries.addAll($queryObj.execute()))
#end
##
##
##
#**
* Retrieves a list of entries to be displayed. The entries are taken from a month of the blog. The target month is
* defined by the request parameters <tt>month</tt> (the month number, from 1 to 12) and <tt>year</tt> (4
* digit year). Initially the current month is displayed.
*
* @param blogDoc The blog document. It should contain a <tt>Blog.BlogClass</tt> object.
* @param query The base query for selecting entries. Apart from the base query that selects entries, it can further be
* refined to restrict to a given space, or to a given search criteria, etc.
* @param entries The resulting list of entries to display, a list of XDocument names.
* @param queryParams The parameters to bind with the query.
*###
#macro(getMonthlyBlogEntries $blogDoc $query $entries)
#if (!$entries)
#setVariable ("$entries" [])
#end
#getRequestedMonth($monthDate)
#set($dateFormatter = $xwiki.jodatime.getDateTimeFormatterForPattern('yyyy-MM-dd'))
#set($minDay = $dateFormatter.print($monthDate.toMutableDateTime().monthOfYear().roundFloor()))
#set($maxDay = $dateFormatter.print($monthDate.toMutableDateTime().monthOfYear().roundCeiling()))
#set($query = "${query} and publishDate.value >= '$minDay' and publishDate.value < '$maxDay'")
#set($countQueryObj = $services.query.hql($query).addFilter("unique"))
#set($queryObj = $services.query.hql("${query} order by publishDate.value desc").addFilter("unique"))
#bindQueryParameters($countQueryObj $queryParams)
#bindQueryParameters($queryObj $queryParams)
#set($totalEntries = $countQueryObj.count())
#set($discard = $entries.addAll($queryObj.execute()))
#end
##
##
##
#**
* Retrieves a list of entries to be displayed. All entries belonging to the current blog are returned.
*
* @param blogDoc The blog document. It should contain a <tt>Blog.BlogClass</tt> object.
* @param query The base query for selecting entries. Apart from the base query that selects entries, it can further be
* refined to restrict to a given space, or to a given search criteria, etc.
* @param entries The resulting list of entries to display, a list of XDocument names.
* @param queryParams The parameters to bind with the query.
*###
#macro(getAllBlogEntries $blogDoc $query $entries $queryParams)
#if (!$entries)
#setVariable ("$entries" [])
#end
#set($countQueryObj = $services.query.hql($query).addFilter("unique"))
#set($queryObj = $services.query.hql("${query} order by publishDate.value desc").addFilter("unique"))
#bindQueryParameters($countQueryObj $queryParams)
#bindQueryParameters($queryObj $queryParams)
#set($totalEntries = $countQueryObj.count())
#set($discard = $entries.addAll($queryObj.execute()))
#end
##
##
##
#**
* Retrieves a list of entries to be displayed. Only (and all) unpublished entries are returned.
*
* @param blogDoc The blog document. It should contain a <tt>Blog.BlogClass</tt> object.
* @param query The base query for selecting entries. Apart from the base query that selects entries, it can further be
* refined to restrict to a given space, or to a given search criteria, etc.
* @param queryParams The parameters to bind with the query.
* @param entries The resulting list of entries to display, a list of XDocument names.
*###
#macro(getUnpublishedBlogEntries $blogDoc $query $queryParams $entries)
#if (!$entries)
#setVariable ("$entries" [])
#end
#set($query = "${query} and isPublished.value = 0")
#set ($countQueryObj = $services.query.hql($query).addFilter("unique"))
#set ($queryObj = $services.query.hql("${query} order by publishDate.value desc").addFilter("unique"))
#bindQueryParameters($countQueryObj $queryParams)
#bindQueryParameters($queryObj $queryParams)
#set($totalEntries = $countQueryObj.count())
#set($discard = $entries.addAll($queryObj.execute()))
#end
##
##
##
#**
* Retrieves a list of entries to be displayed. The entries are taken from all the wiki, and not from a specific blog.
*
* @param entries The resulting list of entries to display, a list of XDocument names.
*###
#macro(getGlobalBlogEntries $entries)
#if (!$entries)
#setVariable ("$entries" [])
#end
#getAllBlogPostsQuery($query)
#set($totalEntries = $services.query.hql($query).count())
#set($defaultItemsPerPage = 20)
## This macro is defined in the default macros.vm library. It also sets $itemsPerPage and $startAt.
#preparePagedViewParams($totalEntries $defaultItemsPerPage)
#set($discard = $entries.addAll($services.query.hql("${query} order by publishDate.value desc").setLimit($itemsPerPage).setOffset($startAt).execute()))
#end
#**
* Return the base query for selecting blog entries. It filters only visible entries, but does not bind to a specific
* blog, nor specify a range or an ordering criteria.
*
* This macro is a duplicate of #getAllBlogPostsQuery($query). Keep it in case it's used outside, in custom code.
*
* @param query The basic query for selecting blog entries.
*#
#macro(getBlogEntriesBaseQuery $query)
#getAllBlogPostsQuery($query)
#end
#**
* Return the Query for selecting the all wiki blog posts without filtering
*
* @param query The basic query for selecting blog entries.
*#
#macro(getAllBlogPostsQuery $query)
#set ($query = $NULL)
#setVariable("$query" ", BaseObject as obj, IntegerProperty isPublished,
IntegerProperty hidden, DateProperty publishDate
where doc.fullName <> '$blogPostTemplate' and
obj.name=doc.fullName and obj.className='$blogPostClassname' and
isPublished.id.id = obj.id and isPublished.id.name = 'published' and
hidden.id.id = obj.id and hidden.id.name='hidden' and
publishDate.id.id = obj.id and publishDate.id.name='publishDate' and
(doc.creator = '$escapetool.sql($xcontext.user)' or (isPublished.value = 1 and hidden.value = 0))")
#end
##
##
##
###**
* Return the Query for selecting the all wiki blog posts with categories filtering
*
* @param query The basic query for selecting blog entries.
*###
#macro(getCategoryAllBlogPostsQuery $query)
#set ($query = $NULL)
#getAllBlogPostsQuery($baseQuery)
#set ($baseQuery = $baseQuery.replace('DateProperty publishDate', 'DateProperty publishDate, DBStringListProperty as category left join category.list catList'))
#setVariable("$query" "${baseQuery} and obj.id=category.id.id and category.id.name='category'")
#end
##
##
##
#**
* Determines how is the blog index split into pages: paginated (fixed number of entries), weekly (all entries in a
* week), monthly (all entries in a month), or all.
*
* @param blogDoc The blog document. It should contain a <tt>Blog.BlogClass</tt> object with the <tt>displayType</tt>
* property set.
* @param displayType The resulting string. If the blog object does not define anything, it is considered paginated.
*###
#macro(getBlogDisplayType $blogDoc $displayType)
#getBlogProperty($blogDoc 'displayType' 'paginated' $result)
#set ($displayType = $NULL)
#setVariable ("$displayType" $result)
#end
##
##
##
#**
* Displays a list of entries.
*
* @param entries The entries to display, a list of XDocument names.
* @param displaying What exactly is displayed: blog index, a single blog entry, a blog category, search results,
* unpublished entries, etc. This will be used as the classname(s) for the container div (hfeed). Currently
* used values: index, single, category, search, unpublished, hidden.
* @param onlyExtract If <tt>true</tt>, only display the extract of articles where available, otherwise display the full content.
* @param shouldDisplayTitles If <tt>true</tt>, display the blog title (blog posts shouldn't display the title when they're
* displayed alone on their page since it's the page title which is used in this case)
*###
#macro(displayBlog $entries $displaying $onlyExtract $shouldDisplayTitles)
#set($blogDay = '')
(% class="hfeed $!{displaying}" %)(((
(% class="blogDay" %)(((
#foreach ($entryDoc in $xwiki.wrapDocs($entries))
#getEntryObject($entryDoc $entryObj)
## Although all entries should have one of the two objects, better check to be sure.
#if("$!{entryObj}" != '')
#getEntryDate($entryDoc $entryObj $entryDate)
## Display a "calendar sheet" for each day. All entries posted on the same day share one such sheet.
#set($entryDateStr = $xwiki.formatDate($entryDate, 'yyyyMMMMdd'))
#if($blogDay != $entryDateStr)
#if($blogDay != '')
)))
(% class="blogDay" %)(((
#end
#displayBlogDate($entryDate)
#set ($blogDay = $entryDateStr)
#end
## Finally, display the entry.
#displayEntry($entryDoc $entryObj $onlyExtract $shouldDisplayTitles true)
#end
#end
)))## blogDay
)))## hfeed
#end
##
##
##
#**
* Get the entry object, either a new BlogPost or an old Article.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The resulting xobject of the blog post.
*###
#macro(getEntryObject $entryDoc $__entryObj)
#set($result = $entryDoc.getObject("${blogPostClassname}"))
#if(!$result)
#set($result = $entryDoc.getObject("${oldArticleClassname}"))
#end
## NOTE: The reason we put an underscore in front of the variable name is to prevent the following line from
## overwriting the $entryObj variable that may be defined before this macro is called. Of course, $__entryObj may be
## overwritten in this case but it's less likely to have such a variable defined before.
#set ($__entryObj = $NULL)
#setVariable ("$__entryObj" $result)
#end
##
##
##
#**
* Gets the date associated with a blog entry. This is the publication date. For unpublished entries, initially this is
* the document creation date, but can be edited by the user.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
* @param result The resulting date, an instance of <tt>java.util.Date</tt>.
*###
#macro(getEntryDate $entryDoc $entryObj $result)
#set ($result = $NULL)
#setVariable ("$result" $entryObj.getProperty('publishDate').value)
#end
##
##
##
#**
* Displays a date, nicely formatted as a calendar page.
*
* @param date The date to display, an instance of <tt>java.util.Date</tt>.
*###
#macro(displayBlogDate $date)
#set($year = $xwiki.formatDate($date, 'yyyy'))
## 3 letter month name, like Jan, Dec.
#set($month = $xwiki.formatDate($date, 'MMM'))
## Uncomment to get a full length month name, like January, December.
## TODO: this could be defined somewhere in the blog style.
## #set($month = $xwiki.formatDate($date, 'MMMM'))
#set($day = $xwiki.formatDate($date, 'dd'))
(% class="blogdate" %)
== (% class="month" %)$month(%%) (% class="day" %)$day(%%) (% class="year" %)$year(%%) ==
#end
##
##
##
#**
* Displays a blog article: management tools, header, content, footer.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
* @param onlyExtract If <tt>true</tt>, try to display only a summary of the entry, instead of the full content.
* @param shouldDisplayTitle If <tt>true</tt>, display the blog title (blog posts shouldn't display the title
* when they're displayed alone on their page since it's the page title which is used in this case)
* @param shouldDisplayActions If <tt>true</tt>, display the blog post actions buttons
*###
#macro(displayEntry $entryDoc $entryObj $onlyExtract $shouldDisplayTitle $shouldDisplayActions)
## Only articles with an explicit hidden setting or an explicit unpublished setting are hidden
#isPublished($entryObj $isPublished)
#isHidden($entryObj $isHidden)
#if($doc.fullName == $entryDoc.fullName)
(% class="hentry single-article" %)(((
#else
(% class="hentry#if(!$isPublished) unpublished-article#elseif($isHidden) hidden-article#end" %)(((
#end
#if ($shouldDisplayActions)
#displayEntryTools($entryDoc $entryObj)
#end
#if($shouldDisplayTitle)
#displayEntryTitle($entryDoc $entryObj)
#end
#if($doc.fullName == $entryDoc.fullName)
#if(!$isPublished)
{{warning}}{{translation key='blog.code.published'/}}{{/warning}}
#elseif($isHidden)
{{warning}}{{translation key='blog.code.hidden'/}}{{/warning}}
#end
#end
#displayEntryContent($entryDoc $entryObj $onlyExtract)
#displayEntryFooter($entryDoc $entryObj)
)))## hentry
#end
##
##
##
#**
* Checks if the provided blog is published or not.
*
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
* @param isPublished The resulting boolean, true if the entry is considered published.
*###
#macro(isPublished $entryObj $isPublished)
#set ($isPublished = $NULL)
## This should work for both old articles, which don't have the 'published' property at all, and
## are considered published by default, and new entries, that should have 1 if published.
#if ("$!{entryObj.getProperty('published').value}" != '0')
#setVariable ("$isPublished" true)
#else
#setVariable ("$isPublished" false)
#end
#end
##
##
##
#**
* Checks if the provided blog is hidden or not.
*
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass<tt> xclass.
* @param isHiddel The resulting boolean, true if the entry is considered hidden.
*###
#macro(isHidden $entryObj $isHidden)
#set ($isHidden = $NULL)
## This should work for both old articles, which don't have the 'hidden' property at all, and
## are considered visible by default, and new entries, that should have 1 if hidden.
#if ("$!{entryObj.getProperty('hidden').value}" == '1')
#setVariable ("$isHidden" true)
#else
#setVariable ("$isHidden" false)
#end
#end
##
##
##
#**
* Displays several "tools" for manipulating blog posts: hide/show, publish, edit.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
*###
#macro(displayEntryTools $entryDoc $entryObj)
#if($xcontext.action == 'view')
(% class="blog-entry-toolbox" %)(((
#displayPublishButton($entryDoc $entryObj)
#displayHideShowButton($entryDoc $entryObj)
#displayEditButton($entryDoc $entryObj)
#displayDeleteButton($entryDoc $entryObj)
)))
#end
#end
##
##
##
#**
* Displays the publish button to the entry <strong>creator</strong>, if the article is not published yet.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
* @todo AJAX calls.
*###
#macro(displayPublishButton $entryDoc $entryObj)
#isPublished($entryObj $isPublished)
#if(!$isPublished && $entryDoc.creator == $xcontext.user && $xwiki.hasAccessLevel('edit', $xcontext.user, $entryDoc.fullName))
[[#toolImage('world')>>path:$blogPublisher.getURL('view', "entryName=${escapetool.url($entryDoc.fullName)}&xredirect=${escapetool.url($thisURL)}&form_token=$!{services.csrf.getToken()}")||title="$services.localization.render('blog.code.notpublished')"]]##
#end
#end
##
##
##
#**
* Displays the hide or show button to the entry <strong>creator</strong>, if the article is already published.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
*###
#macro(displayHideShowButton $entryDoc $entryObj)
#isPublished($entryObj $isPublished)
#isHidden($entryObj $isHidden)
## Only published articles can be hidden. Unpublished articles are considered already hidden.
#if($isPublished && $entryDoc.creator == $xcontext.user && $xwiki.hasAccessLevel('edit', $xcontext.user, $entryDoc.fullName))
#set ($queryString = {
'xredirect' : $thisURL,
'form_token' : $services.csrf.getToken()
})
#if ($isHidden)
#set ($discard = $queryString.putAll({
"${entryObj.getxWikiClass().getName()}_${entryObj.number}_hidden" : 0,
'comment' : $services.localization.render('blog.code.madevisible')
}))
#set ($lockURL = $entryDoc.getURL('save', $escapetool.url($queryString)))
[[#toolImage('unlock')>>path:$lockURL||class="blog-tool-show" title="$services.localization.render('blog.code.makevisible')"]]##
#else
#set ($discard = $queryString.putAll({
"${entryObj.getxWikiClass().getName()}_${entryObj.number}_hidden" : 1,
'comment' : $services.localization.render('blog.code.hid')
}))
#set ($lockURL = $entryDoc.getURL('save', $escapetool.url($queryString)))
[[#toolImage('lock')>>path:$lockURL||class="blog-tool-hide" title="$services.localization.render('blog.code.hide')"]]##
#end
#end
#end
##
##
##
#**
* Displays the edit button to those that can edit the article.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
*###
#macro(displayEditButton $entryDoc $entryObj)
#if($xwiki.hasAccessLevel('edit', $xcontext.user, $entryDoc.fullName))
## Call getDefaultEditMode() for backward compatibility with older blog posts.
[[#toolImage('pencil')>>path:$entryDoc.getURL('edit')||title="$services.localization.render('blog.code.editpost')"]]##
#end
#end
##
##
##
#**
* Displays the delete button to those that can edit the article.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
* @todo AJAX calls.
*###
#macro(displayDeleteButton $entryDoc $entryObj)
#if($xwiki.hasAccessLevel('delete', $xcontext.user, $entryDoc.fullName))
[[#toolImage('cross')>>path:$entryDoc.getURL('delete')||title="$services.localization.render('blog.code.deletepost')"]]##
#end
#end
##
##
##
#**
* Displays the title of the entry.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
*###
#macro(displayEntryTitle $entryDoc $entryObj)
#if($doc.fullName == $entryDoc.fullName)
(% class="entry-title" %)
= $services.rendering.escape($entryDoc.display('title', 'view', $entryObj), $xwiki.getCurrentContentSyntaxId()) =
#else
(% class="entry-title" %)
=== [[$services.rendering.escape($entryDoc.display('title', 'view', $entryObj),$xwiki.getCurrentContentSyntaxId())>>doc:$services.rendering.escape($services.model.serialize($entryDoc.getDocumentReference(),'default'),$xwiki.getCurrentContentSyntaxId())]] ===
#end
#end
##
##
##
#**
* Displays the body of the entry.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
* @param onlyExtract If <tt>true</tt>, try to display only a summary of the entry, instead of the full content.
*###
#macro(displayEntryContent $entryDoc $entryObj $onlyExtract)
(% class="#if($onlyExtract)entry-summary#{else}entry-content#end" %)(((
#getEntryContent($entryDoc $entryObj $onlyExtract $entryContent)
## FIXME: This causes the blog's content to not be annotatable. See http://jira.xwiki.org/browse/XWIKI-6328
## Should probably be replaced by a display macro call with a reference to the object property holding the post's content
{{html wiki="false"}}$entryDoc.getRenderedContent($entryContent, $entryDoc.syntax.toIdString()){{/html}}
))) ## entry-content
(% class="clearfloats" %)((()))
#end
##
##
##
#**
* Extracts the body of the entry that should be displayed. If <tt>onlyExtract</tt> is <tt>true</tt>, display the content
* of the <tt>extract</tt> field (if not empty).
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
* @param onlyExtract If <tt>true</tt>, try to display only a summary of the entry, instead of the full content.
* @param entryContent The resulting content.
*###
#macro(getEntryContent $entryDoc $entryObj $onlyExtract $entryContent)
#if ($onlyExtract)
## Note: We trim the summary so that if there's some white space it won't cause the summary to be used instead
## of the content.
#set ($macro.result = $entryObj.getProperty('extract').value.trim())
#end
#if("$!macro.result" == '')
#set($macro.result = $entryObj.getProperty('content').value)
#* Disabled until the content can be cleanly cut.
* #if($onlyExtract && $result.length()>$maxchars)
* #set($i = $macro.result.lastIndexOf(" ", $maxchars))
* #set($i = $i + 1)
* #set($macro.result = "${macro.result.substring(0,$i)} *[...>${entryDoc.fullName}]*")
* #end
## *###
#else
#if($entryDoc.syntax.toIdString() == 'xwiki/1.0')
#set($macro.result = "${macro.result} <a href='${entryDoc.getURL()}' title='$services.localization.render('blog.code.readpost')'>...</a>")
#elseif($entryDoc.syntax.toIdString() == 'xwiki/2.0' || $entryDoc.syntax.toIdString() == 'xwiki/2.1')
#set($macro.result = "${macro.result} [[...>>${services.rendering.escape($entryDoc.getFullName(), $entryDoc.getSyntax())}||title='$services.localization.render('blog.code.readpost')']]")
#end
#end
#set ($entryContent = $NULL)
#setVariable ("$entryContent" $macro.result)
#end
##
##
##
#**
* Displays the footer of the entry.
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
*###
#macro(displayEntryFooter $entryDoc $entryObj)
(% class="entry-footer" %)(((
#isPublished($entryObj $isPublished)
(% class='entry-author-label' %)
#if($isPublished)
{{translation key='blog.code.postedby'/}} ##
#else
{{translation key='blog.code.createdby'/}} ##
#end
{{html wiki="false" clean="false"}}<span class='author vcard'>#userfn($entryDoc.creator)</span>{{/html}} ##
#getEntryDate($entryDoc $entryObj $entryDate)
#listCategories($entryObj) #*
## Since the publish date and update date are not set at the exact same time, there could be a small difference that
## we assume cannot be more than 3 seconds.
*#(% class="separator" %)·(%%) [[{{translation key='blog.code.permalink'/}}>>$services.rendering.escape($entryDoc,'xwiki/2.0')||rel="bookmark"]] ##
#if ($showcomments)
(% class="separator" %)·(%%) [[{{translation key='blog.code.comments'/}}>>$services.rendering.escape($entryDoc,'xwiki/2.0')||anchor="Comments"]] (% class="itemCount" %)($entryDoc.comments.size())(%%) ##
#end ##
#if($entryDoc != $doc) ##
#displayEntryBlogLocation($entryDoc $entryObj) ##
#end
)))## entry-footer
#end
##
##
#**
* Display the blog for the entry (if it is not the currently displayed blog)
*
* @param entryDoc The xdocument of the blog post. Each post resides in its own document.
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
*###
#macro(displayEntryBlogLocation $entryDoc $entryObj)
#getBlogPostsLocation($entryDoc.getSpace() $blogPostsLocation) ##
#if("$!blogPostsLocation" != "") ##
#set($blogSpaceRef = $services.model.resolveSpace($blogPostsLocation)) ##
#set($blogDocRef = $services.model.createDocumentReference($services.model.getEntityReference('DOCUMENT', 'default').getName(), $blogSpaceRef)) ##
#if($doc.documentReference != $blogDocRef) ##
#set($blogDoc = $xwiki.getDocument($blogDocRef)) ##
#set($blogObj = $blogDoc.getObject('Blog.BlogClass')) ##
#if($blogObj) (% class="blogrefpath" %)((( ##
$services.localization.render('blog.code.postedin') {{html clean="false" wiki="false"}} #hierarchy($blogDocRef, {'selfIsActive' : true, 'local': true}) {{/html}} ##
)))(%%)##
#end
#end
#end
#end
##
##
##
##
#**
* List the categories an entry belongs to. Used in the footer. The categories are instances of <tt>Blog.CategoryClass</tt>.
*
* @param entryObj The xobject of the blog post, an instance of the <tt>Blog.BlogPostClass</tt> xclass.
*###
#macro(listCategories $entryObj)
#if($entryObj.getxWikiClass().getName() == $blogPostClassname)
#set($categories = $entryObj.getProperty('category').value)
#set($first = true)
#if($categories.size() > 0)
#foreach($category in $categories)
#set($categoryDoc = $!xwiki.getDocument($category))
#if(!$categoryDoc.isNew() && $categoryDoc.getObject(${blogCategoryClassname}))
#if($foreach.count == 1)
(% class='separator' %)·(%%) $services.localization.render('blog.code.categories') ##
#else
, ##
#end##
[[$!{categoryDoc.getObject($blogCategoryClassname).getValue('name')}>>${category}||rel='tag']]##
#end##
#end##
#end
#end
#end
##
##
##
#**
* Displays blog pagination links (older and newer entries).
*
* @param blogDoc the XDocument holding the blog definition object.
*###
#macro(displayNavigationLinks $blogDoc)
(% class="clearfloats" %)((()))
#getBlogDisplayType($blogDoc $displayType)
#if($displayType == 'weekly')
(% class="pagingLinks" %)(((
#getRequestedWeek($weekDate)
$weekDate.addWeeks(-1)##
(% class="prevPage" %)**[[« {{translation key='blog.code.previousweek'/}}>>$doc.documentReference.name||queryString="year=$weekDate.weekyear&week=$weekDate.weekOfWeekyear" class="button"]]**(%%)
#sep()
$weekDate.addWeeks(2)## 2 because we already subtracted 1 above
(% class="nextPage" %)**[[{{translation key='blog.code.nextweek'/}} »>>$doc.documentReference.name||queryString="year=$weekDate.weekyear&week=$weekDate.weekOfWeekyear" class="button"]]**(%%)
)))
#elseif($displayType == 'monthly')
(% class="pagingLinks" %)(((
#getRequestedMonth($monthDate)
$monthDate.addMonths(-1)##
(% class="prevPage" %)**[[« {{translation key='blog.code.previousmonth'/}}>>$services.rendering.escape($doc.documentReference.name,$doc.syntax)||queryString="year=$monthDate.year&month=$monthDate.monthOfYear" class="button"]]**(%%)
#sep()
$monthDate.addMonths(2)## 2 because we already subtracted 1 above
(% class="nextPage" %)**[[{{translation key='blog.code.nextmonth'/}} »>>$services.rendering.escape($doc.documentReference.name,$doc.syntax)||queryString="year=$monthDate.year&month=$monthDate.monthOfYear" class="button"]]**(%%)
)))
#elseif($displayType == 'all')
#else
## Paginated
#if(($totalPages > 1))
#set($queryString = '')
#foreach($p in $request.getParameterNames())
#if($p != 'page' && $p != 'ipp')
#foreach($v in $request.getParameterValues($p))
#set($queryString = "${queryString}&${escapetool.url($p)}=${escapetool.url($v)}")
#end
#end
#end
(% class="pagingLinks" %)(((
#if ($currentPageNumber < $totalPages)
#set($currentPageNumber = $currentPageNumber + 1)
(% class="prevPage" %)**[[« {{translation key='blog.code.olderposts'/}}>>$services.rendering.escape($doc.documentReference.name,$doc.syntax)||queryString="page=${currentPageNumber}&ipp=${itemsPerPage}$queryString" class="button"]]**(%%)
#set($currentPageNumber = $currentPageNumber - 1)
#end
#if ($currentPageNumber > 1)
#if ($currentPageNumber < $totalPages)
#sep()
#end
#set($currentPageNumber = $currentPageNumber - 1)
(% class="nextPage" %)**[[{{translation key='blog.code.newerposts'/}} »>>$services.rendering.escape($doc.documentReference.name,$doc.syntax)||queryString="page=${currentPageNumber}&ipp=${itemsPerPage}$queryString" class="button"]]**(%%)
#set($currentPageNumber = $currentPageNumber + 1)
#end
(% class="clear" %)(%%)
)))## pagingLinks
#end
#end
#end
##
##
##
#**
* Displays a message box with "publish" icon.
*
* @param message A text message concerning blog article publishing
*###
#macro(publishMessageBox $message)
(% class="plainmessage publish-message" %)((($services.icon.render('world') $message)))
#end
#**
* Displays a message box with "show/hide" icon.
*
* @param message A text message concerning blog article hiding
*###
#macro(hideMessageBox $message)
(% class="plainmessage hide-message" %)((($services.icon.render('unlock') $message)))
#end
##
##
##
#**
* Determine the requested week, for using in a weekly-indexed blog. The relevant request parameters are
* <tt>year</tt> and <tt>week</tt>. By default, the current week is used.
*
* @param monthDate The resulting week, a JODATime MutableDateTime.
*###
#macro(getRequestedWeek $weekDate)
#set ($weekDate = $NULL)
#setVariable ("$weekDate" $xwiki.jodatime.mutableDateTime)
#if("$!{request.year}" != '')
#set ($discard = $weekDate.setYear($numbertool.toNumber($request.year).intValue()))
#end
#if("$!{request.week}" != '')
#set ($discard = $weekDate.setWeekOfWeekyear($numbertool.toNumber($request.week).intValue()))
#end
#end
##
##
##
#**
* Determine the requested month, for using in a monthly-indexed blog. The relevant request parameters are
* <tt>year</tt> and <tt>month</tt>. By default, the current month is used.
*
* @param monthDate The resulting month, a JODATime MutableDateTime.
*###
#macro(getRequestedMonth $monthDate)
#set ($monthDate = $NULL)
#setVariable ("$monthDate" $xwiki.jodatime.mutableDateTime)
#if("$!{request.year}" != '')
#set ($discard = $monthDate.setYear($numbertool.toNumber($request.year).intValue()))
#end
#if("$!{request.month}" != '')
#set ($discard = $monthDate.setMonthOfYear($numbertool.toNumber($request.month).intValue()))
#end
#end
##
##