-
Notifications
You must be signed in to change notification settings - Fork 11
/
Article.cs
671 lines (582 loc) · 26.5 KB
/
Article.cs
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
// <copyright file="Article.cs" company="Engage Software">
// Engage: Publish
// Copyright (c) 2004-2013
// by Engage Software ( http://www.engagesoftware.com )
// </copyright>
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
// CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
namespace Engage.Dnn.Publish
{
using System;
using System.Data;
using System.Globalization;
using System.Xml.Serialization;
using DotNetNuke.Common;
using DotNetNuke.Common.Utilities;
using DotNetNuke.Entities.Controllers;
using DotNetNuke.Entities.Portals;
using DotNetNuke.Services.Exceptions;
using Engage.Dnn.Publish.Data;
using Engage.Dnn.Publish.Util;
using Localize = DotNetNuke.Services.Localization.Localization;
/// <summary>
/// Summary description for ArticleInfo.
/// ArticleInfo holds all of the article specific information
/// </summary>
[XmlRoot(ElementName = "article", IsNullable = false)]
public class Article : Item
{
private readonly string[] _pageSeperator = new[]
{
"[PAGE]"
};
private string _articleText = string.Empty;
private float _averageRating;
private string _referenceNumber = string.Empty;
private string _versionDescription = string.Empty;
private string _versionNumber = string.Empty;
public Article()
{
this.ItemTypeId = ItemType.Article.GetId();
}
[XmlElement(Order = 39)]
public string ArticleText
{
get { return this._articleText; }
set { this._articleText = value; }
}
/// <summary>
/// Gets the average rating of this article.
/// </summary>
/// <value>The average rating for this article.</value>
[XmlIgnore]
public float AverageRating
{
get { return this._averageRating; }
set
{
// if value is NULL in database, CBO fills it with MinValue
this._averageRating = value != float.MinValue ? value : 0;
}
}
public override string EmailApprovalBody
{
get
{
string body = Localize.GetString(
"EMAIL_APPROVAL_BODY", "~" + Utility.DesktopModuleFolderName + "articlecontrols/App_LocalResources/articleedit");
return body;
}
}
public override string EmailApprovalSubject
{
get
{
string subject = Localize.GetString(
"EMAIL_APPROVAL_SUBJECT", "~" + Utility.DesktopModuleFolderName + "articlecontrols/App_LocalResources/articleedit");
return subject;
}
}
public override string EmailStatusChangeBody
{
get
{
string body = Localize.GetString(
"EMAIL_STATUSCHANGE_BODY", "~" + Utility.DesktopModuleFolderName + "articlecontrols/App_LocalResources/articleedit");
return body;
}
}
public override string EmailStatusChangeSubject
{
get
{
string body = Localize.GetString(
"EMAIL_STATUSCHANGE_SUBJECT", "~" + Utility.DesktopModuleFolderName + "articlecontrols/App_LocalResources/articleedit");
return body;
}
}
public int GetNumberOfPages
{
get
{
// string[] stringSeparators = new string[] { "[PAGE]" };
string[] pagelocations = this._articleText.Split(this._pageSeperator, StringSplitOptions.None);
return pagelocations.Length;
}
}
[XmlElement(Order = 42)]
public string ReferenceNumber
{
get { return this._referenceNumber; }
set { this._referenceNumber = value; }
}
[XmlElement(Order = 41)]
public string VersionDescription
{
get { return this._versionDescription; }
set { this._versionDescription = value; }
}
[XmlElement(Order = 40)]
public string VersionNumber
{
get { return this._versionNumber; }
set { this._versionNumber = value; }
}
public static void AddArticleVersion(
int itemVersionId, int itemId, string versionNumber, string versionDescription, string articleText, string referenceNumber)
{
DataProvider.Instance().AddArticleVersion(itemVersionId, itemId, versionNumber, versionDescription, articleText, referenceNumber);
}
public static void AddArticleVersion(
IDbTransaction trans,
int itemVersionId,
int itemId,
string versionNumber,
string versionDescription,
string articleText,
string referenceNumber)
{
DataProvider.Instance().AddArticleVersion(trans, itemVersionId, itemId, versionNumber, versionDescription, articleText, referenceNumber);
}
public static Article Create(int portalId)
{
var a = new Article
{
PortalId = portalId
};
return a;
}
/// <summary>
/// Creates an Article object that you can continue to modify or save back into the database.
/// </summary>
/// <param name="name">Name of the Category to be created.</param>
/// <param name="description">The description/abstract of the category to be created.</param>
/// <param name="articleText"></param>
/// <param name="authorUserId">The ID of the author of this category.</param>
/// <param name="parentCategoryId"></param>
/// <param name="moduleId">The moduleid for where this category will most likely be displayed.</param>
/// <param name="portalId">The Portal ID of the portal this category belongs to.</param>
/// <returns>A <see cref="Article" /> with the assigned values.</returns>
public static Article Create(
string name, string description, string articleText, int authorUserId, int parentCategoryId, int moduleId, int portalId)
{
var a = new Article
{
Name = name,
Description = description.Replace("<br>", "<br />"),
_articleText = articleText.Replace("<br>", "<br />"),
AuthorUserId = authorUserId
};
// should we strip <br> tags now?
var irel = new ItemRelationship
{
RelationshipTypeId = RelationshipType.ItemToParentCategory.GetId(),
ParentItemId = parentCategoryId
};
a.Relationships.Add(irel);
a.StartDate = a.LastUpdated = a.CreatedDate = DateTime.Now.ToString(CultureInfo.InvariantCulture);
a.PortalId = portalId;
a.ModuleId = moduleId;
Category c = Category.GetCategory(parentCategoryId, portalId);
a.DisplayTabId = c.ChildDisplayTabId;
a.ApprovalStatusId = ApprovalStatus.Approved.GetId();
a.NewWindow = false;
a.SetDefaultItemVersionSettings();
return a;
}
[Obsolete(
"This method should not be used, please use Article.Create. Example: Create(string name, string description, int authorUserId, int moduleId, int portalId, int displayTabId)."
, false)]
public static Article CreateArticle(
string name, string description, string articleText, int authorUserId, int parentCategoryId, int moduleId, int portalId)
{
Article a = Create(name, description, articleText, authorUserId, parentCategoryId, moduleId, portalId);
return a;
}
[Obsolete("This version does not using Caching. Please use GetArticle(itemId, portalId) or version that loads relationships and tags.", false)
]
public static Article GetArticle(int itemId)
{
IDataReader dr = DataProvider.Instance().GetArticle(itemId);
var a = (Article)CBO.FillObject(dr, typeof(Article));
if (a != null)
{
a.CorrectDates();
}
return a;
}
public static Article GetArticle(int itemId, int portalId, bool loadRelationships, bool loadTags)
{
return GetArticle(itemId, portalId, loadRelationships, loadTags, false);
}
public static Article GetArticle(int itemId, int portalId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings)
{
return GetArticle(itemId, portalId, loadRelationships, loadTags, loadItemVersionSettings, false);
}
public static Article GetArticle(int itemId, int portalId, bool loadRelationships, bool loadTags, bool loadItemVersionSettings, bool ignoreCache)
{
string cacheKey = Utility.CacheKeyPublishArticle + itemId.ToString(CultureInfo.InvariantCulture) + "loadRelationships" + loadRelationships +
"loadTags" + loadTags + "loadItemVersionSettings" + loadItemVersionSettings;
Article a;
if (!ignoreCache && ModuleBase.UseCachePortal(portalId))
{
object o = DataCache.GetCache(cacheKey);
if (o != null)
{
a = (Article)o;
}
else
{
a = GetArticle(itemId);
if (a != null)
{
if (loadRelationships)
{
a.LoadRelationships();
}
// we don't need to get the tags if the portal doesn't allow it
if (loadTags && ModuleBase.AllowTagsForPortal(portalId))
{
a.LoadTags();
}
if (loadItemVersionSettings)
{
a.LoadItemVersionSettings();
}
}
}
if (a != null)
{
DataCache.SetCache(cacheKey, a, DateTime.Now.AddMinutes(ModuleBase.CacheTimePortal(portalId)));
Utility.AddCacheKey(cacheKey, portalId);
}
}
else
{
a = GetArticle(itemId);
if (a != null)
{
if (loadRelationships)
{
a.LoadRelationships();
}
// we don't need to get the tags if the portal doesn't allow it
if (loadTags && ModuleBase.AllowTagsForPortal(portalId))
{
a.LoadTags();
}
if (loadItemVersionSettings)
{
a.LoadItemVersionSettings();
}
}
}
return a;
}
public static Article GetArticle(int itemId, int portalId)
{
return GetArticle(itemId, portalId, false, false);
}
public static Article GetArticleVersion(int articleVersionId, int portalId)
{
return GetArticleVersion(articleVersionId, portalId, false);
}
public static Article GetArticleVersion(int articleVersionId, int portalId, bool ignoreCache)
{
string cacheKey = Utility.CacheKeyPublishArticleVersion + articleVersionId.ToString(CultureInfo.InvariantCulture);
Article a;
if (!ignoreCache && ModuleBase.UseCachePortal(portalId))
{
object o = DataCache.GetCache(cacheKey);
if (o != null)
{
a = (Article)o;
}
else
{
a = (Article)CBO.FillObject(DataProvider.Instance().GetArticleVersion(articleVersionId, portalId), typeof(Article));
if (a != null)
{
a.CorrectDates();
}
DataCache.SetCache(cacheKey, a, DateTime.Now.AddMinutes(ModuleBase.CacheTimePortal(portalId)));
Utility.AddCacheKey(cacheKey, portalId);
}
}
else
{
a = (Article)CBO.FillObject(DataProvider.Instance().GetArticleVersion(articleVersionId, portalId), typeof(Article));
if (a != null)
{
a.CorrectDates();
}
}
return a;
}
public static DataTable GetArticles(int portalId)
{
return DataProvider.Instance().GetArticles(portalId);
}
public static DataTable GetArticles(int parentItemId, int portalId)
{
return DataProvider.Instance().GetArticles(parentItemId, portalId);
}
public static DataTable GetArticlesByModuleId(int moduleId, bool isCurrent)
{
if (isCurrent)
{
return DataProvider.Instance().GetArticlesByModuleIdCurrent(moduleId);
}
return DataProvider.Instance().GetArticlesByModuleId(moduleId);
}
public static DataTable GetArticlesByPortalId(int portalId)
{
return DataProvider.Instance().GetArticlesByPortalId(portalId);
}
public static DataTable GetArticlesSearchIndexingNew(int portalId, int displayTabId)
{
return DataProvider.Instance().GetArticlesSearchIndexingNew(portalId, displayTabId);
}
public static DataTable GetArticlesSearchIndexingUpdated(int portalId, int moduleDefId, int displayTabId)
{
return DataProvider.Instance().GetArticlesSearchIndexingUpdated(portalId, moduleDefId, displayTabId);
}
public static int GetOldArticleId(int itemId)
{
return DataProvider.Instance().GetOldArticleId(itemId);
}
public void AddRating(int rating, int? userId)
{
UserFeedback.Rating.AddRating(this.ItemVersionId, userId, rating, DataProvider.ModuleQualifier);
}
public bool DisplayReturnToList()
{
ItemVersionSetting rlSetting = ItemVersionSetting.GetItemVersionSetting(
this.ItemVersionId, "ArticleSettings", "DisplayReturnToList", this.PortalId);
if (rlSetting != null)
{
return Convert.ToBoolean(rlSetting.PropertyValue, CultureInfo.InvariantCulture);
}
return false;
}
public string GetPage(int pageId)
{
string[] pageLocations = this._articleText.Split(this._pageSeperator, StringSplitOptions.None);
if (pageLocations.Length > pageId)
{
return pageLocations[pageId - 1];
}
return pageLocations[pageLocations.Length - 1];
}
/// <summary>
/// This method is invoked by the Import mechanism and has to take this instance of a Article and resolve
/// all the id's using the names supplied in the export. hk
/// </summary>
public override void Import(int currentModuleId, int portalId)
{
// The very first thing is that PortalID needs to be changed to the current portal where content is being
// imported. Several methods resolving Id's is expecting the correct PortalId (current). hk
this.PortalId = portalId;
this.ResolveIds(currentModuleId);
}
public override void Save(int revisingUserId)
{
IDbConnection newConnection = DataProvider.Instance().GetConnection();
IDbTransaction trans = newConnection.BeginTransaction();
try
{
this.SaveInfo(trans, revisingUserId);
UpdateItem(trans, this.ItemId, this.ModuleId);
this.UpdateApprovalStatus(trans);
// update article version now
// replace <br> with <br />
AddArticleVersion(
trans,
this.ItemVersionId,
this.ItemId,
this.VersionNumber,
this.VersionDescription,
this.ArticleText.Replace("<br>", "<br />"),
this.ReferenceNumber);
// Save the Relationships
this.SaveRelationships(trans);
// Save the ItemVersionSettings
// SaveItemVersionSettings(trans);
trans.Commit();
}
catch
{
trans.Rollback();
// Rolling back to the original version, exception thrown.
this.ItemVersionId = this.OriginalItemVersionId;
throw;
}
finally
{
// clean up connection stuff
newConnection.Close();
}
this.SaveItemVersionSettings();
Utility.ClearPublishCache(this.PortalId);
if (HostController.Instance.GetBoolean(Utility.PublishEnableTags + this.PortalId.ToString(CultureInfo.InvariantCulture), false))
{
// Save Tags
this.SaveTags();
}
try
{
if (Utility.IsPingEnabledForPortal(this.PortalId))
{
if (this.ApprovalStatusId == ApprovalStatus.Approved.GetId())
{
string surl = HostController.Instance.GetString(
Utility.PublishPingChangedUrl + this.PortalId.ToString(CultureInfo.InvariantCulture));
string changedUrl = Engage.Utility.HasValue(surl) ? surl : Globals.NavigateURL(this.DisplayTabId);
PortalSettings ps = Utility.GetPortalSettings(this.PortalId);
// ping
Ping.SendPing(ps.PortalName, ps.PortalAlias.ToString(), changedUrl, this.PortalId);
}
}
}
catch (Exception exc)
{
// WHAT IS THIS? Why try/catch and gooble up errors???
// this was added because some exceptions occur for ping servers that we don't need to let the users know about.
// catch the ping exception but let everything else proceed.
// TODO: localize this error
Exceptions.LogException(exc);
// Exceptions.ProcessModuleLoadException(Localize.GetString("PingError", LocalResourceFile), exc);
}
}
public override void UpdateApprovalStatus()
{
IDbConnection newConnection = DataProvider.Instance().GetConnection();
IDbTransaction trans = newConnection.BeginTransaction();
try
{
this.UpdateApprovalStatus(trans);
trans.Commit();
Utility.ClearPublishCache(this.PortalId);
}
catch
{
trans.Rollback();
throw;
}
}
protected override void ResolveIds(int currentModuleId)
{
base.ResolveIds(currentModuleId);
bool save = false;
// now the Unique Id's
// Does this ItemVersion exist in my db?
using (IDataReader dr = DataProvider.Instance().GetItemVersion(this.ItemVersionIdentifier, this.PortalId))
{
if (dr.Read())
{
// this item already exists
// update some stuff???
}
else
{
// this version does not exist.
this.ItemId = -1;
this.ItemVersionId = -1;
this.ModuleId = currentModuleId;
save = true;
}
}
if (save)
{
this.Save(this.RevisingUserId);
}
}
/// <summary>
/// This method will configure the default ItemVersionSettings for an article, it is called from the Create method on article so that users of the API do not have to pass in itemversionsettings.
/// </summary>
private void SetDefaultItemVersionSettings()
{
var hostController = HostController.Instance;
// Printer Friendly
string hostPrinterFriendlySetting =
hostController.GetString(Utility.PublishDefaultPrinterFriendly + this.PortalId.ToString(CultureInfo.InvariantCulture));
Setting setting = Setting.PrinterFriendly;
setting.PropertyValue = Convert.ToBoolean(hostPrinterFriendlySetting, CultureInfo.InvariantCulture).ToString();
var itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
// Email A Friend
string hostEmailFriendSetting =
hostController.GetString(Utility.PublishDefaultEmailAFriend + this.PortalId.ToString(CultureInfo.InvariantCulture));
setting = Setting.EmailAFriend;
setting.PropertyValue = Convert.ToBoolean(hostEmailFriendSetting, CultureInfo.InvariantCulture).ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
// ratings
string hostRatingSetting =
hostController.GetString(Utility.PublishDefaultRatings + this.PortalId.ToString(CultureInfo.InvariantCulture));
setting = Setting.Rating;
setting.PropertyValue = Convert.ToBoolean(hostRatingSetting, CultureInfo.InvariantCulture).ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
// comments
string hostCommentSetting =
hostController.GetString(Utility.PublishDefaultComments + this.PortalId.ToString(CultureInfo.InvariantCulture));
setting = Setting.Comments;
setting.PropertyValue = Convert.ToBoolean(hostCommentSetting, CultureInfo.InvariantCulture).ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
if (ModuleBase.IsPublishCommentTypeForPortal(this.PortalId))
{
// forum comments
setting = Setting.ForumComments;
setting.PropertyValue = Convert.ToBoolean(hostCommentSetting, CultureInfo.InvariantCulture).ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
}
// include all articles from the parent category
setting = Setting.ArticleSettingIncludeCategories;
setting.PropertyValue = false.ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
// display on current page option
setting = Setting.ArticleSettingCurrentDisplay;
setting.PropertyValue = false.ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
// force display on specific page
setting = Setting.ArticleSettingForceDisplay;
setting.PropertyValue = false.ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
// display return to list
setting = Setting.ArticleSettingReturnToList;
setting.PropertyValue = false.ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
// show author
string hostAuthorSetting =
hostController.GetString(Utility.PublishDefaultShowAuthor + this.PortalId.ToString(CultureInfo.InvariantCulture));
setting = Setting.Author;
setting.PropertyValue = Convert.ToBoolean(hostAuthorSetting, CultureInfo.InvariantCulture).ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
// show tags
string hostTagsSetting = hostController.GetString(
Utility.PublishDefaultShowTags + this.PortalId.ToString(CultureInfo.InvariantCulture));
setting = Setting.ShowTags;
setting.PropertyValue = Convert.ToBoolean(hostTagsSetting, CultureInfo.InvariantCulture).ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
// use approvals
string hostUseApprovalsSetting =
hostController.GetString(Utility.PublishUseApprovals + this.PortalId.ToString(CultureInfo.InvariantCulture));
setting = Setting.UseApprovals;
setting.PropertyValue = Convert.ToBoolean(hostUseApprovalsSetting, CultureInfo.InvariantCulture).ToString();
itemVersionSetting = new ItemVersionSetting(setting);
this.VersionSettings.Add(itemVersionSetting);
}
}
}