Merge pull request #6 from valadas/Issue5

Brings the module Dnn 9.2 compatible

Author: EPTamminga

.gitignore

@@ -15,6 +15,7 @@
 ## Ignore VS2015/Roslyn artifacts
 *.sln.ide/
 .vs/
+*.lock
 
 ## Ignore Webstorm artifacts
 *.idea/
@@ -40,13 +41,15 @@
 .builds
 *.dotCover
 *.ldf
+*.zip
 
 # git merge artifacts
 *.orig
 *.gitmodules
 
 ## TODO: If you have NuGet Package Restore enabled, uncomment this
 [Pp]ackages/
+[Bb]in/
 
 # Visual Studio profiler
 *.psess

AnnouncementsEdit.ascx

@@ -9,7 +9,7 @@
 <%@ Register TagPrefix="dnn" TagName="FilePickerUploader" Src="~/controls/filepickeruploader.ascx" %>
 <%@ Import Namespace="DotNetNuke.Services.Localization" %>
 <%@ Register TagPrefix="dnn" Namespace="DotNetNuke.UI.WebControls" Assembly="DotNetNuke" %>
-<%@ Register TagPrefix="dnn" Namespace="DotNetNuke.Web.UI.WebControls" Assembly="DotNetNuke.Web" %>
+<%@ Register TagPrefix="dnn" Namespace="DotNetNuke.Web.UI.WebControls" Assembly="DotNetNuke.Web.Deprecated" %>
 <div class="dnnForm dnnAnnouncementForm dnnClear" id="AnnouncementsForm">
     <ul class="dnnAdminTabNav dnnClear" id="">
         <li id="contentTab" runat="server"><a href="#dnnContent"><%=LocalizeString("content.Tab")%></a></li>

AnnouncementsEdit.ascx.cs

@@ -31,6 +31,7 @@
 using DotNetNuke.Common;
 using DotNetNuke.Common.Utilities;
 using DotNetNuke.Framework;
+using DotNetNuke.Framework.JavaScriptLibraries;
 using DotNetNuke.Modules.Announcements.Components.Business;
 using DotNetNuke.Modules.Announcements.Components.Common;
 using DotNetNuke.Modules.Announcements.MVP.Models;
@@ -67,8 +68,8 @@ public partial class AnnouncementsEdit : ModuleView<AnnouncementsEditModel>, IAn
         override protected void OnInit(EventArgs e)
         {
             base.OnInit(e);
-
-            jQuery.RequestDnnPluginsRegistration();
+            
+            JavaScript.RequestRegistration(CommonJs.DnnPlugins);
 
             ClientResourceManager.RegisterStyleSheet(Page, Globals.ApplicationPath + "/DesktopModules/Announcements/AnnouncementsEdit.css", FileOrder.Css.ModuleCss);
 

AnnouncementsSettings.ascx.cs

@@ -73,14 +73,30 @@ protected override void OnSettingsLoaded()
 
             try
             {
-                txtHistory.Text = Model.Settings.History.ToDnnString();
-                txtDescriptionLength.Text = Model.Settings.DescriptionLength.ToDnnString();
-                txtEditorHeight.Text = Model.Settings.EditorHeight.ToDnnString();
                 foreach (Enum i in Enum.GetValues(typeof(ViewTypes)))
                 {
                     ddlViewType.Items.Add(new ListItem(Localization.GetString(Enum.GetName(typeof(ViewTypes), i), LocalResourceFile), Enum.GetName(typeof(ViewTypes), i)));
                 }
-                ddlViewType.SelectedValue = Utilities.ViewTypeToString(Model.Settings.DefaultViewType);
+                
+                // This is not perfect, but the only way I found how to fix the settings reading issue, original code commented below.
+                if (Model.ModuleSettings != null)
+                {
+                    if (Model.ModuleSettings.ContainsKey("history"))
+                        txtHistory.Text = Model.ModuleSettings["history"].ToString();
+                    if (Model.ModuleSettings.ContainsKey("descriptionLength"))
+                        txtDescriptionLength.Text = Model.ModuleSettings["descriptionLength"].ToString();
+                    if (Model.ModuleSettings.ContainsKey("editorHeight"))
+                        txtEditorHeight.Text = Model.ModuleSettings["editorHeight"].ToString();
+                    if (Model.ModuleSettings.ContainsKey("defaultViewType"))
+                        ddlViewType.SelectedValue = Model.ModuleSettings["defaultViewType"].ToString();
+                }
+                //if (Model.Settings != null)
+                //{
+                //    txtHistory.Text = Model.Settings.History.ToDnnString();
+                //    txtDescriptionLength.Text = Model.Settings.DescriptionLength.ToDnnString();
+                //    txtEditorHeight.Text = Model.Settings.EditorHeight.ToDnnString();                    
+                //    ddlViewType.SelectedValue = Utilities.ViewTypeToString(Model.Settings.DefaultViewType);
+                //}
             }
             catch (Exception exc)
             {

AnnouncementsView.ascx.cs

@@ -40,7 +40,9 @@ protected override void OnLoad(EventArgs e)
             var localTemplate = (BaseTemplate)Model.Template;
             if (!string.IsNullOrEmpty(localTemplate.JsFile) && File.Exists(Server.MapPath(localTemplate.JsFile)))
             {
-                Framework.jQuery.RegisterJQuery(Page);
+                // Framework.jQuery.RegisterJQuery(Page);
+                // Should not be required, jQuery is loaded by default
+
                     ClientResourceManager.RegisterScript(Page, localTemplate.JsFile);
             }
             if (!string.IsNullOrEmpty(localTemplate.CssFile) && File.Exists(Server.MapPath(localTemplate.CssFile)))

AssemblyInfo.cs

@@ -0,0 +1,13 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by a tool.
+//     Runtime Version:4.0.30319.42000
+//
+//     Changes to this file may cause incorrect behavior and will be lost if
+//     the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+
+[assembly: System.Reflection.AssemblyVersion("07.02.00.00")]
+
+

Components/Business/AnnouncementInfo.cs

@@ -239,8 +239,7 @@ private bool CheckFileOrTab(string link, string contentType)
                 // the link is a file. Check wether it exists in the portal
                 if (Int32.TryParse(link.Replace("FileID=", ""), out intId))
                 {
-                    var objFileController = new FileController();
-                    FileInfo objFile = objFileController.GetFileById(intId, portal.PortalId);
+                    var objFile = FileManager.Instance.GetFile(intId);
                     if (objFile != null)
                     {
                         if ((!(string.IsNullOrEmpty(contentType))) && (!(objFile.ContentType.StartsWith(contentType, StringComparison.OrdinalIgnoreCase))))
@@ -354,7 +353,7 @@ public void WriteXml(XmlWriter writer)
 
         public string GetProperty(string strPropertyName, string strFormat, CultureInfo formatProvider, UserInfo AccessingUser, Scope AccessLevel, ref bool PropertyNotFound)
         {
-            PortalSettings portalSettings = PortalController.GetCurrentPortalSettings();
+            PortalSettings portalSettings = PortalController.Instance.GetCurrentPortalSettings();
             string outputFormat = strFormat == string.Empty ? "D" : strFormat;
             switch (strPropertyName.ToLowerInvariant())
             {
@@ -398,9 +397,8 @@ public string GetProperty(string strPropertyName, string strFormat, CultureInfo
                         // this is now legacy, from version 7.0.0, a real filename is saved in the DB
                         if (ImageSource.StartsWith("FileID="))
                         {
-                            var fileCnt = new FileController();
-                            FileInfo objFile = fileCnt.GetFileById(Convert.ToInt32(strValue.Substring(7)),
-                                                                   portalSettings.PortalId);
+
+                            var objFile = FileManager.Instance.GetFile(Convert.ToInt32(strValue.Substring(7)));
                             if (objFile != null)
                             {
                                 strValue = portalSettings.HomeDirectory + objFile.Folder + objFile.FileName;

Components/Business/AnnouncementsController.cs

@@ -41,6 +41,7 @@
 using DotNetNuke.Entities.Users;
 using DotNetNuke.Services.Journal;
 using DotNetNuke.Services.Search;
+using DotNetNuke.Services.Search.Entities;
 using DotNetNuke.Services.Social.Messaging;
 using DotNetNuke.Services.Social.Notifications;
 
@@ -53,7 +54,7 @@ namespace DotNetNuke.Modules.Announcements.Components.Business
     /// The AnnouncementsController Class represents the Announcments Business Layer
     /// Methods in this class call methods in the Data Layer
     /// </summary>
-    public class AnnouncementsController : IAnnouncementsController, ISearchable, IPortable
+    public class AnnouncementsController : ModuleSearchBase, IAnnouncementsController, IPortable
     {
 
         #region Public Methods
@@ -191,7 +192,7 @@ public IEnumerable<AnnouncementInfo> GetExpiredAnnouncements(int moduleId)
         }
 
 
-        public void AddAnnouncementToJournal(AnnouncementInfo announcement, int tabId, String journalType)
+        public void AddAnnouncementToJournal(AnnouncementInfo announcement, String journalType, ModuleInfo moduleInfo)
         {
 
             var objJournalType = JournalController.Instance.GetJournalType(journalType);
@@ -214,7 +215,7 @@ public void AddAnnouncementToJournal(AnnouncementInfo announcement, int tabId, S
             journalItem.JournalTypeId = objJournalType.JournalTypeId;
             journalItem.SecuritySet = "E,";
 
-            JournalController.Instance.SaveJournalItem(journalItem, tabId);
+            JournalController.Instance.SaveJournalItem(journalItem, moduleInfo);
 
         }
 
@@ -248,48 +249,46 @@ public void SendNotifications(AnnouncementInfo announcement)
 
         #endregion
 
-        #region ISearchable Implementation
+        #region ModuleSearchBase Implementation
 
-        /// <summary>
-        /// GetSearchItems implements the ISearchable Interface
-        /// </summary>
-        /// <remarks>
-        /// </remarks>
-        public SearchItemInfoCollection GetSearchItems(ModuleInfo ModInfo)
+        public override IList<SearchDocument> GetModifiedSearchDocuments(ModuleInfo moduleInfo, DateTime beginDateUtc)
         {
-            Hashtable moduleSettings = Entities.Portals.PortalSettings.GetModuleSettings(ModInfo.ModuleID);
-            int descriptionLength = 100;
-            if (Convert.ToString(moduleSettings["descriptionLength"]) != "")
+            var moduleSettings = moduleInfo.ModuleSettings;
+            int descriptionLenght = 100;
+            if (moduleSettings["descriptionLength"].ToString() != "")
             {
-                descriptionLength = int.Parse(Convert.ToString(moduleSettings["descriptionLength"]));
-                if (descriptionLength < 1)
-                {
-                    descriptionLength = 1950;
-                    //max length of description is 2000 char, take a bit less to make sure it fits...
-                }
+                int.TryParse(moduleSettings["descriptionLength"].ToString(), out descriptionLenght);
+                if (descriptionLenght < 1) { descriptionLenght = 1950; }                    
+                    //max length of description is 2000 char, take a bit less to make sure it fits...                
             }
-
-            var searchItemCollection = new SearchItemInfoCollection();
-
-            IEnumerable<AnnouncementInfo> announcements = GetCurrentAnnouncements(ModInfo.ModuleID, Null.NullDate);
-
-            foreach (AnnouncementInfo objAnnouncement in announcements)
+            var searchDocuments = new List<SearchDocument>();
+            var announcements = GetAnnouncements(moduleInfo.ModuleID, beginDateUtc, DateTime.MaxValue);
+            foreach (var announcement in announcements)
             {
-                var tempVar = objAnnouncement;
-                string strContent = System.Web.HttpUtility.HtmlDecode(tempVar.Title + " " + tempVar.Description);
-                string strDescription =
-                    HtmlUtils.Shorten(HtmlUtils.Clean(System.Web.HttpUtility.HtmlDecode(tempVar.Description), false),
-                                      descriptionLength, "...");
-                var searchItem = new SearchItemInfo(ModInfo.ModuleTitle + " - " + tempVar.Title, strDescription,
-                                                               tempVar.CreatedByUserID, tempVar.PublishDate.Value, ModInfo.ModuleID,
-                                                               tempVar.ItemID.ToString(CultureInfo.InvariantCulture), strContent,
-                                                               "ItemID=" + tempVar.ItemID.ToString(CultureInfo.InvariantCulture));
-                searchItemCollection.Add(searchItem);
+                var document = new SearchDocument();
+                document.AuthorUserId = announcement.CreatedByUserID;
+                document.Body = announcement.Description;
+                document.CultureCode = moduleInfo.CultureCode;
+                document.Description = announcement.Description;
+                document.IsActive = CheckIfAnnouncementIsActive(announcement);
+                document.ModifiedTimeUtc = announcement.LastModifiedOnDate;
+                document.ModuleDefId = moduleInfo.ModuleDefID;
+                document.ModuleId = moduleInfo.ModuleID;
+                document.PortalId = moduleInfo.PortalID;
+                document.TabId = moduleInfo.TabID;
+                document.Title = announcement.Title;
+                document.UniqueKey = moduleInfo.ModuleID.ToString();
+                searchDocuments.Add(document);
             }
+            return searchDocuments;
+        }
 
-            return searchItemCollection;
+        private bool CheckIfAnnouncementIsActive(AnnouncementInfo announcement)
+        {
+            return (announcement.PublishDate < DateTime.Now && (announcement.ExpireDate == null || announcement.ExpireDate > DateTime.Now));
         }
 
+
         #endregion
 
         #region IPortable Implementation
@@ -440,7 +439,7 @@ private AnnouncementInfo ImportAnnouncement(XmlNode xmlAnnouncement)
             {
                 return null;
             }
-        }
+        }        
 
         #endregion
 

Components/Business/IAnnouncementsController.cs

@@ -26,7 +26,7 @@
 
 using System;
 using System.Collections.Generic;
-
+using DotNetNuke.Entities.Modules;
 using DotNetNuke.Entities.Users;
 
 #endregion
@@ -53,7 +53,7 @@ public interface IAnnouncementsController
 
         IEnumerable<AnnouncementInfo> GetExpiredAnnouncements(int moduleId);
 
-        void AddAnnouncementToJournal(AnnouncementInfo announcement, int tabId, String journalType);
+        void AddAnnouncementToJournal(AnnouncementInfo announcement, String journalType, ModuleInfo moduleInfo);
 
         void SendNotifications(AnnouncementInfo announcement);
 

Components/Settings/Settings.cs

@@ -80,9 +80,9 @@ public Settings(int moduleId, int tabModuleId)
             _moduleId = moduleId;
             _tabModuleId = tabModuleId;
 
-            var mc = new ModuleController();
-            ModuleSettings = mc.GetModuleSettings(_moduleId);
-            TabModuleSettings = mc.GetTabModuleSettings(_tabModuleId);
+            var moduleInfo = new ModuleController().GetModule(_moduleId);
+            ModuleSettings = moduleInfo.ModuleSettings;
+            TabModuleSettings = moduleInfo.TabModuleSettings;
 
             History = TabModuleSettings.GetInteger(SettingName.History, _History);
             DescriptionLength = TabModuleSettings.GetInteger(SettingName.DescriptionLength, _DescriptionLength);
@@ -120,7 +120,9 @@ public void Update()
 
 
             ModuleController.SynchronizeModule(_moduleId);
-            DataCache.RemoveCache(ModuleController.CacheKey(_moduleId) + "_viewType");
+            // DataCache.RemoveCache(ModuleController.CacheKey(_moduleId) + "_viewType");
+            // Module caching has been updated in 5.2.0, this method is no longer used
+
             DataCache.RemoveCache(CacheConstants.SettingsCacheKeyFormat(_moduleId, _tabModuleId));
 
         }

Documentation/releasenotes.txt

@@ -1,4 +1,13 @@
 MODULE: DotNetNuke Announcements Module
+
+Version: 07.02.00
+Minimum Required DNN Version: 8.0.0
+
+* Replaced all deprecated APIs usage
+* Tested for Dnn 9.2.0 compatibility
+
+------------------------------------
+
 Version: 07.00.00 CTP
 Minimum Required DNN Version: 7.0.0 RC