2012-10-05 11:03:08 -02:00
using System ;
2013-02-09 10:58:21 -01:00
using System.Collections.Generic ;
2012-12-20 08:53:28 -01:00
using System.IO ;
2012-10-05 11:03:08 -02:00
using System.Linq ;
2012-12-20 08:53:28 -01:00
using System.Web ;
2012-12-13 13:05:23 -01:00
using System.Xml.Linq ;
2014-05-15 12:49:03 +10:00
using Newtonsoft.Json ;
using Newtonsoft.Json.Linq ;
2012-12-20 08:53:28 -01:00
using Umbraco.Core.IO ;
2013-02-18 15:46:18 -01:00
using Umbraco.Core.Media ;
2013-08-07 11:39:25 +10:00
using Umbraco.Core.Models.EntityBase ;
2012-11-11 06:53:02 -01:00
using Umbraco.Core.Models.Membership ;
2013-06-20 15:34:57 +10:00
using Umbraco.Core.Services ;
2012-10-05 11:03:08 -02:00
namespace Umbraco.Core.Models
{
public static class ContentExtensions
{
2013-02-09 11:12:51 -01:00
#region IContent
2013-08-07 11:39:25 +10:00
2014-03-06 17:50:08 +11:00
/// <summary>
/// Returns true if this entity was just published as part of a recent save operation (i.e. it wasn't previously published)
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>
/// <remarks>
/// This is helpful for determining if the published event will execute during the saved event for a content item.
/// </remarks>
internal static bool JustPublished ( this IContent entity )
{
var dirty = ( IRememberBeingDirty ) entity ;
return dirty . WasPropertyDirty ( "Published" ) & & entity . Published ;
}
2014-10-21 13:12:31 +10:00
/// <summary>
/// Determines if the item should be persisted at all
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>
/// <remarks>
/// In one particular case, a content item shouldn't be persisted:
/// * The item exists and is published
/// * A call to ContentService.Save is made
/// * The item has not been modified whatsoever apart from changing it's published status from published to saved
///
/// In this case, there is no reason to make any database changes at all
/// </remarks>
internal static bool RequiresSaving ( this IContent entity )
{
var publishedState = ( ( Content ) entity ) . PublishedState ;
return RequiresSaving ( entity , publishedState ) ;
}
/// <summary>
/// Determines if the item should be persisted at all
/// </summary>
/// <param name="entity"></param>
/// <param name="publishedState"></param>
/// <returns></returns>
/// <remarks>
/// In one particular case, a content item shouldn't be persisted:
/// * The item exists and is published
/// * A call to ContentService.Save is made
/// * The item has not been modified whatsoever apart from changing it's published status from published to saved
///
/// In this case, there is no reason to make any database changes at all
/// </remarks>
internal static bool RequiresSaving ( this IContent entity , PublishedState publishedState )
{
2015-05-07 11:43:53 +10:00
var publishedChanged = entity . IsPropertyDirty ( "Published" ) & & publishedState ! = PublishedState . Unpublished ;
2014-10-21 13:12:31 +10:00
//check if any user prop has changed
2015-05-07 11:43:53 +10:00
var propertyValueChanged = entity . IsAnyUserPropertyDirty ( ) ;
2014-10-21 13:12:31 +10:00
//We need to know if any other property apart from Published was changed here
//don't create a new version if the published state has changed to 'Save' but no data has actually been changed
if ( publishedChanged & & entity . Published = = false & & propertyValueChanged = = false )
{
//at this point we need to check if any non property value has changed that wasn't the published state
var changedProps = ( ( TracksChangesEntityBase ) entity ) . GetDirtyProperties ( ) ;
if ( changedProps . Any ( x = > x ! = "Published" ) = = false )
{
return false ;
}
}
return true ;
}
2013-08-07 11:39:25 +10:00
/// <summary>
/// Determines if a new version should be created
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>
/// <remarks>
/// A new version needs to be created when:
/// * The publish status is changed
/// * The language is changed
2013-08-08 10:42:06 +10:00
/// * The item is already published and is being published again and any property value is changed (to enable a rollback)
2013-08-07 11:39:25 +10:00
/// </remarks>
internal static bool ShouldCreateNewVersion ( this IContent entity )
{
var publishedState = ( ( Content ) entity ) . PublishedState ;
return ShouldCreateNewVersion ( entity , publishedState ) ;
}
2015-05-07 11:43:53 +10:00
/// <summary>
/// Returns a list of all dirty user defined properties
/// </summary>
/// <returns></returns>
public static IEnumerable < string > GetDirtyUserProperties ( this IContentBase entity )
{
return entity . Properties . Where ( x = > x . IsDirty ( ) ) . Select ( x = > x . Alias ) ;
}
public static bool IsAnyUserPropertyDirty ( this IContentBase entity )
{
return entity . Properties . Any ( x = > x . IsDirty ( ) ) ;
}
public static bool WasAnyUserPropertyDirty ( this IContentBase entity )
{
return entity . Properties . Any ( x = > x . WasDirty ( ) ) ;
}
2013-08-07 11:39:25 +10:00
/// <summary>
/// Determines if a new version should be created
/// </summary>
/// <param name="entity"></param>
/// <param name="publishedState"></param>
/// <returns></returns>
/// <remarks>
/// A new version needs to be created when:
/// * The publish status is changed
/// * The language is changed
2013-08-08 10:42:06 +10:00
/// * The item is already published and is being published again and any property value is changed (to enable a rollback)
2013-08-07 11:39:25 +10:00
/// </remarks>
internal static bool ShouldCreateNewVersion ( this IContent entity , PublishedState publishedState )
{
2013-08-08 10:42:06 +10:00
//check if the published state has changed or the language
2015-05-07 11:43:53 +10:00
var publishedChanged = entity . IsPropertyDirty ( "Published" ) & & publishedState ! = PublishedState . Unpublished ;
var langChanged = entity . IsPropertyDirty ( "Language" ) ;
2014-10-21 13:12:31 +10:00
var contentChanged = publishedChanged | | langChanged ;
//check if any user prop has changed
2015-05-07 11:43:53 +10:00
var propertyValueChanged = entity . IsAnyUserPropertyDirty ( ) ;
2013-08-07 11:39:25 +10:00
2013-08-08 10:42:06 +10:00
//return true if published or language has changed
if ( contentChanged )
{
return true ;
}
2013-08-07 11:39:25 +10:00
2013-08-08 10:42:06 +10:00
//check if any content prop has changed
2013-10-04 17:13:57 +10:00
var contentDataChanged = ( ( Content ) entity ) . IsEntityDirty ( ) ;
2013-08-08 10:42:06 +10:00
//return true if the item is published and a property has changed or if any content property has changed
return ( propertyValueChanged & & publishedState = = PublishedState . Published ) | | contentDataChanged ;
2013-08-07 11:39:25 +10:00
}
2013-08-13 11:01:49 +10:00
/// <summary>
/// Determines if the published db flag should be set to true for the current entity version and all other db
/// versions should have their flag set to false.
/// </summary>
/// <param name="entity"></param>
/// <returns></returns>
/// <remarks>
/// This is determined by:
/// * If a new version is being created and the entity is published
/// * If the published state has changed and the entity is published OR the entity has been un-published.
/// </remarks>
internal static bool ShouldClearPublishedFlagForPreviousVersions ( this IContent entity )
{
var publishedState = ( ( Content ) entity ) . PublishedState ;
return entity . ShouldClearPublishedFlagForPreviousVersions ( publishedState , entity . ShouldCreateNewVersion ( publishedState ) ) ;
}
/// <summary>
/// Determines if the published db flag should be set to true for the current entity version and all other db
/// versions should have their flag set to false.
/// </summary>
/// <param name="entity"></param>
/// <param name="publishedState"></param>
/// <param name="isCreatingNewVersion"></param>
/// <returns></returns>
/// <remarks>
/// This is determined by:
/// * If a new version is being created and the entity is published
/// * If the published state has changed and the entity is published OR the entity has been un-published.
/// </remarks>
internal static bool ShouldClearPublishedFlagForPreviousVersions ( this IContent entity , PublishedState publishedState , bool isCreatingNewVersion )
{
if ( isCreatingNewVersion & & entity . Published )
{
return true ;
}
//If Published state has changed then previous versions should have their publish state reset.
//If state has been changed to unpublished the previous versions publish state should also be reset.
2014-10-21 13:12:31 +10:00
if ( entity . IsPropertyDirty ( "Published" ) & & ( entity . Published | | publishedState = = PublishedState . Unpublished ) )
2013-08-13 11:01:49 +10:00
{
return true ;
}
return false ;
}
2013-02-09 10:58:21 -01:00
/// <summary>
/// Returns a list of the current contents ancestors, not including the content itself.
/// </summary>
/// <param name="content">Current content</param>
/// <returns>An enumerable list of <see cref="IContent"/> objects</returns>
public static IEnumerable < IContent > Ancestors ( this IContent content )
{
return ApplicationContext . Current . Services . ContentService . GetAncestors ( content ) ;
}
/// <summary>
/// Returns a list of the current contents children.
/// </summary>
/// <param name="content">Current content</param>
/// <returns>An enumerable list of <see cref="IContent"/> objects</returns>
public static IEnumerable < IContent > Children ( this IContent content )
{
return ApplicationContext . Current . Services . ContentService . GetChildren ( content . Id ) ;
}
/// <summary>
/// Returns a list of the current contents descendants, not including the content itself.
/// </summary>
/// <param name="content">Current content</param>
/// <returns>An enumerable list of <see cref="IContent"/> objects</returns>
public static IEnumerable < IContent > Descendants ( this IContent content )
{
return ApplicationContext . Current . Services . ContentService . GetDescendants ( content ) ;
}
/// <summary>
/// Returns the parent of the current content.
/// </summary>
/// <param name="content">Current content</param>
/// <returns>An <see cref="IContent"/> object</returns>
public static IContent Parent ( this IContent content )
{
return ApplicationContext . Current . Services . ContentService . GetById ( content . ParentId ) ;
}
2013-02-09 11:12:51 -01:00
#endregion
#region IMedia
/// <summary>
/// Returns a list of the current medias ancestors, not including the media itself.
/// </summary>
/// <param name="media">Current media</param>
/// <returns>An enumerable list of <see cref="IMedia"/> objects</returns>
public static IEnumerable < IMedia > Ancestors ( this IMedia media )
{
return ApplicationContext . Current . Services . MediaService . GetAncestors ( media ) ;
}
/// <summary>
/// Returns a list of the current medias children.
/// </summary>
/// <param name="media">Current media</param>
/// <returns>An enumerable list of <see cref="IMedia"/> objects</returns>
public static IEnumerable < IMedia > Children ( this IMedia media )
{
return ApplicationContext . Current . Services . MediaService . GetChildren ( media . Id ) ;
}
/// <summary>
/// Returns a list of the current medias descendants, not including the media itself.
/// </summary>
/// <param name="media">Current media</param>
/// <returns>An enumerable list of <see cref="IMedia"/> objects</returns>
public static IEnumerable < IMedia > Descendants ( this IMedia media )
{
return ApplicationContext . Current . Services . MediaService . GetDescendants ( media ) ;
}
/// <summary>
/// Returns the parent of the current media.
/// </summary>
/// <param name="media">Current media</param>
/// <returns>An <see cref="IMedia"/> object</returns>
public static IMedia Parent ( this IMedia media )
{
return ApplicationContext . Current . Services . MediaService . GetById ( media . ParentId ) ;
}
#endregion
2013-02-09 10:58:21 -01:00
2013-08-05 16:13:27 +10:00
internal static bool IsInRecycleBin ( this IContent content )
{
return IsInRecycleBin ( content , Constants . System . RecycleBinContent ) ;
}
internal static bool IsInRecycleBin ( this IMedia media )
{
return IsInRecycleBin ( media , Constants . System . RecycleBinMedia ) ;
}
internal static bool IsInRecycleBin ( this IContentBase content , int recycleBinId )
{
return content . Path . Split ( new [ ] { ',' } , StringSplitOptions . RemoveEmptyEntries )
. Contains ( recycleBinId . ToInvariantString ( ) ) ;
}
2014-08-13 09:38:40 +02:00
/// <summary>
/// Removes characters that are not valide XML characters from all entity properties
/// of type string. See: http://stackoverflow.com/a/961504/5018
/// </summary>
/// <returns></returns>
/// <remarks>
/// If this is not done then the xml cache can get corrupt and it will throw YSODs upon reading it.
/// </remarks>
/// <param name="entity"></param>
public static void SanitizeEntityPropertiesForXmlStorage ( this IContentBase entity )
{
entity . Name = entity . Name . ToValidXmlString ( ) ;
foreach ( var property in entity . Properties )
{
if ( property . Value is string )
{
2015-12-08 12:53:11 +01:00
var value = ( string ) property . Value ;
2014-08-13 09:38:40 +02:00
property . Value = value . ToValidXmlString ( ) ;
}
}
}
2013-08-05 16:13:27 +10:00
2013-06-20 15:34:57 +10:00
/// <summary>
/// Checks if the IContentBase has children
/// </summary>
/// <param name="content"></param>
/// <param name="services"></param>
/// <returns></returns>
/// <remarks>
/// This is a bit of a hack because we need to type check!
/// </remarks>
internal static bool HasChildren ( IContentBase content , ServiceContext services )
{
if ( content is IContent )
{
return services . ContentService . HasChildren ( content . Id ) ;
}
if ( content is IMedia )
{
return services . MediaService . HasChildren ( content . Id ) ;
}
return false ;
}
/// <summary>
/// Returns the children for the content base item
/// </summary>
/// <param name="content"></param>
/// <param name="services"></param>
/// <returns></returns>
/// <remarks>
/// This is a bit of a hack because we need to type check!
/// </remarks>
internal static IEnumerable < IContentBase > Children ( IContentBase content , ServiceContext services )
{
if ( content is IContent )
{
return services . ContentService . GetChildren ( content . Id ) ;
}
if ( content is IMedia )
{
return services . MediaService . GetChildren ( content . Id ) ;
}
return null ;
}
2013-05-30 21:21:52 -10:00
/// <summary>
/// Returns properties that do not belong to a group
/// </summary>
/// <param name="content"></param>
/// <returns></returns>
public static IEnumerable < Property > GetNonGroupedProperties ( this IContentBase content )
{
2013-08-09 12:10:42 +10:00
var propertyIdsInTabs = content . PropertyGroups . SelectMany ( pg = > pg . PropertyTypes ) ;
2013-07-25 15:31:26 +10:00
return content . Properties
2013-08-09 12:10:42 +10:00
. Where ( property = > propertyIdsInTabs . Contains ( property . PropertyType ) = = false )
2013-07-25 15:31:26 +10:00
. OrderBy ( x = > x . PropertyType . SortOrder ) ;
2013-05-30 21:21:52 -10:00
}
/// <summary>
/// Returns the Property object for the given property group
/// </summary>
/// <param name="content"></param>
/// <param name="propertyGroup"></param>
/// <returns></returns>
public static IEnumerable < Property > GetPropertiesForGroup ( this IContentBase content , PropertyGroup propertyGroup )
{
//get the properties for the current tab
return content . Properties
. Where ( property = > propertyGroup . PropertyTypes
. Select ( propertyType = > propertyType . Id )
2013-07-25 15:31:26 +10:00
. Contains ( property . PropertyTypeId ) )
. OrderBy ( x = > x . PropertyType . SortOrder ) ;
2013-10-04 17:13:57 +10:00
}
2013-05-30 21:21:52 -10:00
2012-10-05 11:03:08 -02:00
/// <summary>
/// Set property values by alias with an annonymous object
/// </summary>
2012-11-02 09:11:23 -01:00
public static void PropertyValues ( this IContent content , object value )
{
if ( value = = null )
throw new Exception ( "No properties has been passed in" ) ;
2012-10-05 11:03:08 -02:00
2012-11-02 09:11:23 -01:00
var propertyInfos = value . GetType ( ) . GetProperties ( ) ;
foreach ( var propertyInfo in propertyInfos )
{
//Check if a PropertyType with alias exists thus being a valid property
var propertyType = content . PropertyTypes . FirstOrDefault ( x = > x . Alias = = propertyInfo . Name ) ;
if ( propertyType = = null )
throw new Exception (
string . Format (
"The property alias {0} is not valid, because no PropertyType with this alias exists" ,
propertyInfo . Name ) ) ;
2012-10-05 11:03:08 -02:00
2012-11-02 09:11:23 -01:00
//Check if a Property with the alias already exists in the collection thus being updated or inserted
var item = content . Properties . FirstOrDefault ( x = > x . Alias = = propertyInfo . Name ) ;
if ( item ! = null )
{
item . Value = propertyInfo . GetValue ( value , null ) ;
//Update item with newly added value
content . Properties . Add ( item ) ;
}
else
{
//Create new Property to add to collection
var property = propertyType . CreatePropertyFromValue ( propertyInfo . GetValue ( value , null ) ) ;
content . Properties . Add ( property ) ;
}
}
}
2015-12-08 12:53:11 +01:00
public static IContentTypeComposition GetContentType ( this IContentBase contentBase )
{
if ( contentBase = = null ) throw new ArgumentNullException ( "contentBase" ) ;
var content = contentBase as IContent ;
if ( content ! = null ) return content . ContentType ;
var media = contentBase as IMedia ;
if ( media ! = null ) return media . ContentType ;
var member = contentBase as IMember ;
if ( member ! = null ) return member . ContentType ;
throw new NotSupportedException ( "Unsupported IContentBase implementation: " + contentBase . GetType ( ) . FullName + "." ) ;
}
2013-10-04 17:13:57 +10:00
#region SetValue for setting file contents
2012-12-20 08:53:28 -01:00
/// <summary>
/// Sets and uploads the file from a HttpPostedFileBase object as the property value
/// </summary>
2013-02-19 11:06:00 -01:00
/// <param name="content"><see cref="IContentBase"/> to add property value to</param>
2012-12-20 08:53:28 -01:00
/// <param name="propertyTypeAlias">Alias of the property to save the value on</param>
/// <param name="value">The <see cref="HttpPostedFileBase"/> containing the file that will be uploaded</param>
2013-01-14 11:02:12 -01:00
public static void SetValue ( this IContentBase content , string propertyTypeAlias , HttpPostedFileBase value )
2012-12-20 08:53:28 -01:00
{
2015-12-08 12:53:11 +01:00
// ensure we get the filename without the path in IE in intranet mode
2013-02-19 11:06:00 -01:00
// http://stackoverflow.com/questions/382464/httppostedfile-filename-different-from-ie
2015-12-08 12:53:11 +01:00
var filename = value . FileName ;
var pos = filename . LastIndexOf ( @"\" , StringComparison . InvariantCulture ) ;
if ( pos > 0 )
filename = filename . Substring ( pos + 1 ) ;
2013-02-19 11:06:00 -01:00
2015-12-08 12:53:11 +01:00
// strip any directory info
pos = filename . LastIndexOf ( IOHelper . DirSepChar ) ;
if ( pos > 0 )
filename = filename . Substring ( pos + 1 ) ;
2012-12-20 08:53:28 -01:00
2015-12-08 12:53:11 +01:00
// get a safe filename - should this be done by MediaHelper?
filename = IOHelper . SafeFileName ( filename ) ;
if ( string . IsNullOrWhiteSpace ( filename ) ) return ;
filename = filename . ToLower ( ) ; // fixme - er... why?
MediaHelper . SetUploadFile ( content , propertyTypeAlias , filename , value . InputStream ) ;
2012-12-20 08:53:28 -01:00
}
/// <summary>
/// Sets and uploads the file from a HttpPostedFile object as the property value
/// </summary>
2013-02-19 11:06:00 -01:00
/// <param name="content"><see cref="IContentBase"/> to add property value to</param>
2012-12-20 08:53:28 -01:00
/// <param name="propertyTypeAlias">Alias of the property to save the value on</param>
/// <param name="value">The <see cref="HttpPostedFile"/> containing the file that will be uploaded</param>
2013-01-14 11:02:12 -01:00
public static void SetValue ( this IContentBase content , string propertyTypeAlias , HttpPostedFile value )
2012-12-20 08:53:28 -01:00
{
2013-09-03 16:35:36 +10:00
SetValue ( content , propertyTypeAlias , ( HttpPostedFileBase ) new HttpPostedFileWrapper ( value ) ) ;
2012-12-20 08:53:28 -01:00
}
/// <summary>
/// Sets and uploads the file from a HttpPostedFileWrapper object as the property value
/// </summary>
2013-02-19 11:06:00 -01:00
/// <param name="content"><see cref="IContentBase"/> to add property value to</param>
2012-12-20 08:53:28 -01:00
/// <param name="propertyTypeAlias">Alias of the property to save the value on</param>
/// <param name="value">The <see cref="HttpPostedFileWrapper"/> containing the file that will be uploaded</param>
2013-09-03 16:35:36 +10:00
[Obsolete("There is no reason for this overload since HttpPostedFileWrapper inherits from HttpPostedFileBase")]
2013-01-14 11:02:12 -01:00
public static void SetValue ( this IContentBase content , string propertyTypeAlias , HttpPostedFileWrapper value )
2012-12-20 08:53:28 -01:00
{
2013-09-03 16:35:36 +10:00
SetValue ( content , propertyTypeAlias , ( HttpPostedFileBase ) value ) ;
2013-02-19 11:06:00 -01:00
}
2013-10-04 17:13:57 +10:00
2013-02-19 11:06:00 -01:00
/// <summary>
2015-12-08 12:53:11 +01:00
/// Sets a content item property value with a file coming from a stream.
2013-02-19 11:06:00 -01:00
/// </summary>
2015-12-08 12:53:11 +01:00
/// <param name="content">The content item.</param>
/// <param name="propertyTypeAlias">The property type alias.</param>
/// <param name="filename">Name of the file</param>
/// <param name="filestream">The stream containing the file data.</param>
/// <remarks>This really is for FileUpload fields only, and should be obsoleted. For anything else,
/// you need to store the file by yourself using <see cref="StoreFile"/> and then figure out
/// how to deal with auto-fill properties (if any) and thumbnails (if any) by yourself.</remarks>
public static void SetValue ( this IContentBase content , string propertyTypeAlias , string filename , Stream filestream )
2013-02-19 11:06:00 -01:00
{
2015-12-08 12:53:11 +01:00
if ( filename = = null | | filestream = = null ) return ;
// get a safe filename - should this be done by MediaHelper?
filename = IOHelper . SafeFileName ( filename ) ;
if ( string . IsNullOrWhiteSpace ( filename ) ) return ;
filename = filename . ToLower ( ) ; // fixme - er... why?
2013-03-22 14:18:45 -01:00
2015-12-08 12:53:11 +01:00
MediaHelper . SetUploadFile ( content , propertyTypeAlias , filename , filestream ) ;
2012-12-20 08:53:28 -01:00
}
2015-12-08 12:53:11 +01:00
public static string StoreFile ( this IContentBase content , string propertyTypeAlias , string filename , Stream filestream , string oldpath )
2012-12-20 08:53:28 -01:00
{
2015-12-08 12:53:11 +01:00
var propertyType = content . GetContentType ( )
. CompositionPropertyTypes . FirstOrDefault ( x = > x . Alias . InvariantEquals ( propertyTypeAlias ) ) ;
if ( propertyType = = null ) throw new ArgumentException ( "Invalid property type alias " + propertyTypeAlias + "." ) ;
return MediaHelper . StoreFile ( content , propertyType , filename , filestream , oldpath ) ;
2012-12-20 08:53:28 -01:00
}
2013-10-04 17:13:57 +10:00
#endregion
#region User / Profile methods
2014-09-30 18:46:02 +10:00
2013-10-04 17:13:57 +10:00
/// <summary>
/// Gets the <see cref="IProfile"/> for the Creator of this media item.
/// </summary>
2014-10-01 10:18:51 +10:00
[Obsolete("Use the overload that declares the IUserService to use")]
2013-10-04 17:13:57 +10:00
public static IProfile GetCreatorProfile ( this IMedia media )
{
2013-01-28 09:02:28 -01:00
return ApplicationContext . Current . Services . UserService . GetProfileById ( media . CreatorId ) ;
}
2013-01-05 22:46:50 +03:00
2014-09-30 18:46:02 +10:00
/// <summary>
/// Gets the <see cref="IProfile"/> for the Creator of this media item.
/// </summary>
public static IProfile GetCreatorProfile ( this IMedia media , IUserService userService )
{
return userService . GetProfileById ( media . CreatorId ) ;
}
2012-11-06 10:47:14 -01:00
/// <summary>
2013-01-27 16:02:59 -01:00
/// Gets the <see cref="IProfile"/> for the Creator of this content item.
2012-11-06 10:47:14 -01:00
/// </summary>
2014-10-01 10:18:51 +10:00
[Obsolete("Use the overload that declares the IUserService to use")]
2013-01-24 12:25:48 -01:00
public static IProfile GetCreatorProfile ( this IContentBase content )
2012-11-06 10:47:14 -01:00
{
2013-01-28 09:02:28 -01:00
return ApplicationContext . Current . Services . UserService . GetProfileById ( content . CreatorId ) ;
2012-11-06 10:47:14 -01:00
}
2012-11-06 15:17:58 -01:00
2014-09-30 18:46:02 +10:00
/// <summary>
/// Gets the <see cref="IProfile"/> for the Creator of this content item.
/// </summary>
public static IProfile GetCreatorProfile ( this IContentBase content , IUserService userService )
{
return userService . GetProfileById ( content . CreatorId ) ;
}
2012-11-06 15:17:58 -01:00
/// <summary>
2012-11-11 06:53:02 -01:00
/// Gets the <see cref="IProfile"/> for the Writer of this content.
2012-11-06 15:17:58 -01:00
/// </summary>
2014-10-01 10:18:51 +10:00
[Obsolete("Use the overload that declares the IUserService to use")]
2012-11-11 06:53:02 -01:00
public static IProfile GetWriterProfile ( this IContent content )
2012-11-06 15:17:58 -01:00
{
2013-01-28 09:02:28 -01:00
return ApplicationContext . Current . Services . UserService . GetProfileById ( content . WriterId ) ;
2012-11-06 15:17:58 -01:00
}
2014-09-30 18:46:02 +10:00
/// <summary>
/// Gets the <see cref="IProfile"/> for the Writer of this content.
/// </summary>
public static IProfile GetWriterProfile ( this IContent content , IUserService userService )
{
return userService . GetProfileById ( content . WriterId ) ;
}
2013-10-04 17:13:57 +10:00
#endregion
2012-12-14 15:19:54 -01:00
2012-12-21 09:45:34 -01:00
/// <summary>
/// Checks whether an <see cref="IContent"/> item has any published versions
/// </summary>
/// <param name="content"></param>
/// <returns>True if the content has any published versiom otherwise False</returns>
2015-02-10 15:28:48 +01:00
[Obsolete("Use the HasPublishedVersion property.", false)]
2012-12-21 09:45:34 -01:00
public static bool HasPublishedVersion ( this IContent content )
{
2015-02-10 15:28:48 +01:00
return content . HasPublishedVersion ;
2012-12-21 09:45:34 -01:00
}
2014-05-15 12:49:03 +10:00
2013-10-04 17:13:57 +10:00
#region Tag methods
2013-10-24 11:49:09 +11:00
///// <summary>
///// Returns the tags for the given property
///// </summary>
///// <param name="content"></param>
///// <param name="propertyTypeAlias"></param>
///// <param name="tagGroup"></param>
///// <returns></returns>
///// <remarks>
///// The tags returned are only relavent for published content & saved media or members
///// </remarks>
//public static IEnumerable<ITag> GetTags(this IContentBase content, string propertyTypeAlias, string tagGroup = "default")
//{
//}
2013-10-04 17:13:57 +10:00
/// <summary>
/// Sets tags for the property - will add tags to the tags table and set the property value to be the comma delimited value of the tags.
/// </summary>
/// <param name="content">The content item to assign the tags to</param>
2013-10-08 10:58:47 +11:00
/// <param name="propertyTypeAlias">The property alias to assign the tags to</param>
2013-10-04 17:13:57 +10:00
/// <param name="tags">The tags to assign</param>
/// <param name="replaceTags">True to replace the tags on the current property with the tags specified or false to merge them with the currently assigned ones</param>
/// <param name="tagGroup">The group/category to assign the tags, the default value is "default"</param>
/// <returns></returns>
2013-10-08 12:25:03 +11:00
public static void SetTags ( this IContentBase content , string propertyTypeAlias , IEnumerable < string > tags , bool replaceTags , string tagGroup = "default" )
2014-05-15 12:49:03 +10:00
{
content . SetTags ( TagCacheStorageType . Csv , propertyTypeAlias , tags , replaceTags , tagGroup ) ;
}
/// <summary>
/// Sets tags for the property - will add tags to the tags table and set the property value to be the comma delimited value of the tags.
/// </summary>
/// <param name="content">The content item to assign the tags to</param>
/// <param name="storageType">The tag storage type in cache (default is csv)</param>
/// <param name="propertyTypeAlias">The property alias to assign the tags to</param>
/// <param name="tags">The tags to assign</param>
/// <param name="replaceTags">True to replace the tags on the current property with the tags specified or false to merge them with the currently assigned ones</param>
/// <param name="tagGroup">The group/category to assign the tags, the default value is "default"</param>
/// <returns></returns>
public static void SetTags ( this IContentBase content , TagCacheStorageType storageType , string propertyTypeAlias , IEnumerable < string > tags , bool replaceTags , string tagGroup = "default" )
2013-10-04 17:13:57 +10:00
{
2013-10-08 10:58:47 +11:00
var property = content . Properties [ propertyTypeAlias ] ;
2013-10-04 17:13:57 +10:00
if ( property = = null )
{
2013-10-08 10:58:47 +11:00
throw new IndexOutOfRangeException ( "No property exists with name " + propertyTypeAlias ) ;
2013-10-04 17:13:57 +10:00
}
2014-07-01 12:53:07 +10:00
property . SetTags ( storageType , propertyTypeAlias , tags , replaceTags , tagGroup ) ;
}
internal static void SetTags ( this Property property , TagCacheStorageType storageType , string propertyTypeAlias , IEnumerable < string > tags , bool replaceTags , string tagGroup = "default" )
{
if ( property = = null ) throw new ArgumentNullException ( "property" ) ;
2013-10-04 17:13:57 +10:00
var trimmedTags = tags . Select ( x = > x . Trim ( ) ) . ToArray ( ) ;
property . TagSupport . Enable = true ;
property . TagSupport . Tags = trimmedTags . Select ( x = > new Tuple < string , string > ( x , tagGroup ) ) ;
property . TagSupport . Behavior = replaceTags ? PropertyTagBehavior . Replace : PropertyTagBehavior . Merge ;
//ensure the property value is set to the same thing
if ( replaceTags )
{
2014-05-15 12:49:03 +10:00
switch ( storageType )
{
case TagCacheStorageType . Csv :
property . Value = string . Join ( "," , trimmedTags ) ;
break ;
case TagCacheStorageType . Json :
//json array
property . Value = JsonConvert . SerializeObject ( trimmedTags ) ;
break ;
}
2013-10-04 17:13:57 +10:00
}
else
{
2014-05-15 12:49:03 +10:00
switch ( storageType )
{
case TagCacheStorageType . Csv :
var currTags = property . Value . ToString ( ) . Split ( new [ ] { ',' } , StringSplitOptions . RemoveEmptyEntries )
2013-10-04 17:13:57 +10:00
. Select ( x = > x . Trim ( ) ) ;
2014-05-15 12:49:03 +10:00
property . Value = string . Join ( "," , trimmedTags . Union ( currTags ) ) ;
break ;
case TagCacheStorageType . Json :
var currJson = JsonConvert . DeserializeObject < JArray > ( property . Value . ToString ( ) ) ;
//need to append the new ones
foreach ( var tag in trimmedTags )
{
currJson . Add ( tag ) ;
}
//json array
property . Value = JsonConvert . SerializeObject ( currJson ) ;
break ;
}
2013-10-04 17:13:57 +10:00
}
}
/// <summary>
/// Remove any of the tags specified in the collection from the property if they are currently assigned.
/// </summary>
/// <param name="content"></param>
2013-10-08 10:58:47 +11:00
/// <param name="propertyTypeAlias"></param>
2013-10-04 17:13:57 +10:00
/// <param name="tags"></param>
/// <param name="tagGroup">The group/category that the tags are currently assigned to, the default value is "default"</param>
2013-10-08 12:25:03 +11:00
public static void RemoveTags ( this IContentBase content , string propertyTypeAlias , IEnumerable < string > tags , string tagGroup = "default" )
2013-10-04 17:13:57 +10:00
{
2013-10-08 10:58:47 +11:00
var property = content . Properties [ propertyTypeAlias ] ;
2013-10-04 17:13:57 +10:00
if ( property = = null )
{
2013-10-08 10:58:47 +11:00
throw new IndexOutOfRangeException ( "No property exists with name " + propertyTypeAlias ) ;
2013-10-04 17:13:57 +10:00
}
var trimmedTags = tags . Select ( x = > x . Trim ( ) ) . ToArray ( ) ;
property . TagSupport . Behavior = PropertyTagBehavior . Remove ;
property . TagSupport . Enable = true ;
property . TagSupport . Tags = trimmedTags . Select ( x = > new Tuple < string , string > ( x , tagGroup ) ) ;
//set the property value
var currTags = property . Value . ToString ( ) . Split ( new [ ] { ',' } , StringSplitOptions . RemoveEmptyEntries )
. Select ( x = > x . Trim ( ) ) ;
property . Value = string . Join ( "," , currTags . Except ( trimmedTags ) ) ;
}
2012-12-14 15:19:54 -01:00
2013-10-04 17:13:57 +10:00
#endregion
#region XML methods
2014-10-01 10:18:51 +10:00
2013-03-01 03:04:29 +06:00
/// <summary>
/// Creates the full xml representation for the <see cref="IContent"/> object and all of it's descendants
/// </summary>
/// <param name="content"><see cref="IContent"/> to generate xml for</param>
2014-10-01 10:18:51 +10:00
/// <param name="packagingService"></param>
2013-03-01 03:04:29 +06:00
/// <returns>Xml representation of the passed in <see cref="IContent"/></returns>
2014-10-01 10:18:51 +10:00
internal static XElement ToDeepXml ( this IContent content , IPackagingService packagingService )
2013-03-01 03:04:29 +06:00
{
2014-10-01 10:18:51 +10:00
return packagingService . Export ( content , true , raiseEvents : false ) ;
2013-03-01 03:04:29 +06:00
}
2012-12-14 15:19:54 -01:00
/// <summary>
/// Creates the xml representation for the <see cref="IContent"/> object
/// </summary>
/// <param name="content"><see cref="IContent"/> to generate xml for</param>
/// <returns>Xml representation of the passed in <see cref="IContent"/></returns>
2014-10-01 10:18:51 +10:00
[Obsolete("Use the overload that declares the IPackagingService to use")]
2012-12-14 15:19:54 -01:00
public static XElement ToXml ( this IContent content )
{
2014-01-20 10:37:46 +01:00
return ApplicationContext . Current . Services . PackagingService . Export ( content , raiseEvents : false ) ;
2012-12-14 15:19:54 -01:00
}
2014-10-01 10:18:51 +10:00
/// <summary>
/// Creates the xml representation for the <see cref="IContent"/> object
/// </summary>
/// <param name="content"><see cref="IContent"/> to generate xml for</param>
/// <param name="packagingService"></param>
/// <returns>Xml representation of the passed in <see cref="IContent"/></returns>
public static XElement ToXml ( this IContent content , IPackagingService packagingService )
{
return packagingService . Export ( content , raiseEvents : false ) ;
}
2013-01-24 06:16:44 +03:00
/// <summary>
/// Creates the xml representation for the <see cref="IMedia"/> object
/// </summary>
/// <param name="media"><see cref="IContent"/> to generate xml for</param>
/// <returns>Xml representation of the passed in <see cref="IContent"/></returns>
2014-10-01 10:18:51 +10:00
[Obsolete("Use the overload that declares the IPackagingService to use")]
2013-01-24 09:50:27 -01:00
public static XElement ToXml ( this IMedia media )
2013-01-24 06:16:44 +03:00
{
2014-01-20 10:37:46 +01:00
return ApplicationContext . Current . Services . PackagingService . Export ( media , raiseEvents : false ) ;
2013-01-24 06:16:44 +03:00
}
2013-01-05 22:46:50 +03:00
2014-10-01 10:18:51 +10:00
/// <summary>
/// Creates the xml representation for the <see cref="IMedia"/> object
/// </summary>
/// <param name="media"><see cref="IContent"/> to generate xml for</param>
/// <param name="packagingService"></param>
/// <returns>Xml representation of the passed in <see cref="IContent"/></returns>
public static XElement ToXml ( this IMedia media , IPackagingService packagingService )
{
return packagingService . Export ( media , raiseEvents : false ) ;
}
2013-10-18 16:16:30 +11:00
/// <summary>
2013-12-17 14:53:21 +11:00
/// Creates the full xml representation for the <see cref="IMedia"/> object and all of it's descendants
2013-10-18 16:16:30 +11:00
/// </summary>
2013-12-17 14:53:21 +11:00
/// <param name="media"><see cref="IMedia"/> to generate xml for</param>
2014-10-01 10:18:51 +10:00
/// <param name="packagingService"></param>
2013-12-17 14:53:21 +11:00
/// <returns>Xml representation of the passed in <see cref="IMedia"/></returns>
2014-10-01 10:18:51 +10:00
internal static XElement ToDeepXml ( this IMedia media , IPackagingService packagingService )
2013-10-18 16:16:30 +11:00
{
2014-10-01 10:18:51 +10:00
return packagingService . Export ( media , true , raiseEvents : false ) ;
2013-10-18 16:16:30 +11:00
}
2014-05-15 12:49:03 +10:00
2012-12-14 15:19:54 -01:00
/// <summary>
/// Creates the xml representation for the <see cref="IContent"/> object
/// </summary>
/// <param name="content"><see cref="IContent"/> to generate xml for</param>
/// <param name="isPreview">Boolean indicating whether the xml should be generated for preview</param>
/// <returns>Xml representation of the passed in <see cref="IContent"/></returns>
2014-10-01 10:18:51 +10:00
[Obsolete("Use the overload that declares the IPackagingService to use")]
2012-12-14 15:19:54 -01:00
public static XElement ToXml ( this IContent content , bool isPreview )
{
//TODO Do a proper implementation of this
//If current IContent is published we should get latest unpublished version
return content . ToXml ( ) ;
2012-11-06 15:17:58 -01:00
}
2013-12-17 14:53:21 +11:00
2014-10-01 10:18:51 +10:00
/// <summary>
/// Creates the xml representation for the <see cref="IContent"/> object
/// </summary>
/// <param name="content"><see cref="IContent"/> to generate xml for</param>
/// <param name="packagingService"></param>
/// <param name="isPreview">Boolean indicating whether the xml should be generated for preview</param>
/// <returns>Xml representation of the passed in <see cref="IContent"/></returns>
public static XElement ToXml ( this IContent content , IPackagingService packagingService , bool isPreview )
{
//TODO Do a proper implementation of this
//If current IContent is published we should get latest unpublished version
return content . ToXml ( packagingService ) ;
}
2013-12-17 14:53:21 +11:00
/// <summary>
/// Creates the xml representation for the <see cref="IMember"/> object
/// </summary>
/// <param name="member"><see cref="IMember"/> to generate xml for</param>
/// <returns>Xml representation of the passed in <see cref="IContent"/></returns>
2014-10-01 10:18:51 +10:00
[Obsolete("Use the overload that declares the IPackagingService to use")]
2013-12-17 14:53:21 +11:00
public static XElement ToXml ( this IMember member )
{
2014-01-08 14:12:39 +01:00
return ( ( PackagingService ) ( ApplicationContext . Current . Services . PackagingService ) ) . Export ( member ) ;
2013-12-17 14:53:21 +11:00
}
2014-10-01 10:18:51 +10:00
/// <summary>
/// Creates the xml representation for the <see cref="IMember"/> object
/// </summary>
/// <param name="member"><see cref="IMember"/> to generate xml for</param>
/// <param name="packagingService"></param>
/// <returns>Xml representation of the passed in <see cref="IContent"/></returns>
public static XElement ToXml ( this IMember member , IPackagingService packagingService )
{
return ( ( PackagingService ) ( packagingService ) ) . Export ( member ) ;
}
2013-10-04 17:13:57 +10:00
#endregion
2012-10-05 11:03:08 -02:00
}
}