From 070fa11f8cb4e8c8f3149d37a4b37cb873d0924e Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Mon, 8 Jan 2018 14:11:53 +0100 Subject: [PATCH 01/10] fixes: U4-10707 Config to order tour groups --- .../src/common/services/tour.service.js | 29 ++++++++++++++++++- .../common/drawers/help/help.controller.js | 6 ++-- .../src/views/common/drawers/help/help.html | 18 ++++++------ 3 files changed, 40 insertions(+), 13 deletions(-) diff --git a/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js b/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js index 1955cf7219..5ad997ce76 100644 --- a/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js +++ b/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js @@ -218,7 +218,34 @@ var deferred = $q.defer(); var tours = getTours(); setTourStatuses(tours).then(function() { - var groupedTours = _.groupBy(tours, "group"); + var groupedTours = []; + var sortedTours = _.sortBy(tours, 'groupOrder'); + + sortedTours.forEach(function (item) { + + var groupExists = false; + var newGroup = { + "group": "", + "tours": [] + }; + + groupedTours.forEach(function(group){ + // extend existing group if it is already added + if(group.group === item.group) { + groupExists = true; + group.tours.push(item) + } + }); + + // push new group to array if it doesn't exist + if(!groupExists) { + newGroup.group = item.group; + newGroup.tours.push(item); + groupedTours.push(newGroup); + } + + }); + deferred.resolve(groupedTours); }); return deferred.promise; diff --git a/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.controller.js b/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.controller.js index 34a3d8a811..4d2b43c078 100644 --- a/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.controller.js +++ b/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.controller.js @@ -124,7 +124,7 @@ function showTourButton(index, tourGroup) { if(index !== 0) { - var prevTour = tourGroup[index - 1]; + var prevTour = tourGroup.tours[index - 1]; if(prevTour.completed) { return true; } @@ -147,12 +147,12 @@ // Finding out, how many tours are completed for the progress circle angular.forEach(vm.tours, function(group){ var completedTours = 0; - angular.forEach(group, function(tour){ + angular.forEach(group.tours, function(tour){ if(tour.completed) { completedTours++; } }); - group.completedPercentage = Math.round((completedTours/group.length)*100); + group.completedPercentage = Math.round((completedTours/group.tours.length)*100); }); } diff --git a/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.html b/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.html index 5e1d5d271e..e755512b02 100644 --- a/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.html +++ b/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.html @@ -12,23 +12,23 @@
Tours
-
+
- -
- {{key}} - Other + +
+ {{tourGroup.group}} + Other
-
-
+
+
{{ $index + 1 }}
@@ -36,7 +36,7 @@ {{ tour.name }}
- +
From b15def99c7caae750b629f55b1d610ec1afc48a3 Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Tue, 9 Jan 2018 11:53:21 +0100 Subject: [PATCH 02/10] format as json --- .../BackOfficeTours/getting-started.json | 398 +++++++++--------- 1 file changed, 199 insertions(+), 199 deletions(-) diff --git a/src/Umbraco.Web.UI/config/BackOfficeTours/getting-started.json b/src/Umbraco.Web.UI/config/BackOfficeTours/getting-started.json index 1e75e21cc0..72c11f4937 100644 --- a/src/Umbraco.Web.UI/config/BackOfficeTours/getting-started.json +++ b/src/Umbraco.Web.UI/config/BackOfficeTours/getting-started.json @@ -88,111 +88,111 @@ "group": "Getting Started", "steps": [ { - title: "Create your first Document Type", - content: "

Step 1 of any site is to create a Document Type.
A Document Type is a template for content. For each type of content you want to create you'll create a Document Type. This will define were content based on this Document Type can be created, how many properties it holds and what the input method should be for these properties.

When you have at least one Document type in place you can start creating content and this content can the be used in a template.

In this tour you will learn how to set up a basic Document Type with a property to enter a short text.

", - type: "intro" + "title": "Create your first Document Type", + "content": "

Step 1 of any site is to create a Document Type.
A Document Type is a template for content. For each type of content you want to create you'll create a Document Type. This will define were content based on this Document Type can be created, how many properties it holds and what the input method should be for these properties.

When you have at least one Document type in place you can start creating content and this content can the be used in a template.

In this tour you will learn how to set up a basic Document Type with a property to enter a short text.

", + "type": "intro" }, { - element: "#applications [data-element='section-settings']", - title: "Navigate to the Settings sections", - content: "In the Settings section you can create and manage Document types.", - event: "click", - backdropOpacity: 0.6 + "element": "#applications [data-element='section-settings']", + "title": "Navigate to the Settings sections", + "content": "In the Settings section you can create and manage Document types.", + "event": "click", + "backdropOpacity": 0.6 }, { - element: "#tree [data-element='tree-item-documentTypes']", - title: "Create Document Type", - content: "

Hover the Document Type tree and click the three small dots to open the context menu.

", - event: "click", - eventElement: "#tree [data-element='tree-item-documentTypes'] [data-element='tree-item-options']" + "element": "#tree [data-element='tree-item-documentTypes']", + "title": "Create Document Type", + "content": "

Hover the Document Type tree and click the three small dots to open the context menu.

", + "event": "click", + "eventElement": "#tree [data-element='tree-item-documentTypes'] [data-element='tree-item-options']" }, { - element: "#dialog [data-element='action-documentType']", - title: "Create Document Type", - content: "

Click Document Type to create a new document type with a template. The template will be automatically created and set as the default template for this Document Type

You will use the template in a later tour render content.

", - event: "click" + "element": "#dialog [data-element='action-documentType']", + "title": "Create Document Type", + "content": "

Click Document Type to create a new document type with a template. The template will be automatically created and set as the default template for this Document Type

You will use the template in a later tour render content.

", + "event": "click" }, { - element: "[data-element='editor-name-field']", - title: "Enter a name", - content: "

Your Document Type needs a name. Enter My Home Page in the field and click Next.", - view: "doctypename" + "element": "[data-element='editor-name-field']", + "title": "Enter a name", + "content": "

Your Document Type needs a name. Enter My Home Page in the field and click Next.", + "view": "doctypename" }, { - element: "[data-element='editor-description']", - title: "Enter a description", - content: "

A description helps to pick the right document type when creating content.

Write a description to our Home page. It could be: 

The home page of the website

" + "element": "[data-element='editor-description']", + "title": "Enter a description", + "content": "

A description helps to pick the right document type when creating content.

Write a description to our Home page. It could be: 

The home page of the website

" }, { - element: "[data-element='group-add']", - title: "Add tab", - content: "Tabs are used to organize properties on content in the Content section. Click Add new tab to add a tab.", - event: "click" + "element": "[data-element='group-add']", + "title": "Add tab", + "content": "Tabs are used to organize properties on content in the Content section. Click Add new tab to add a tab.", + "event": "click" }, { - element: "[data-element='group-name-field']", - title: "Name the tab", - content: "

Enter Home in the tab name.

You can name a tab anything you want and if you have a lot of properties it can be useful to add multiple tabs.

", - view: "tabName" + "element": "[data-element='group-name-field']", + "title": "Name the tab", + "content": "

Enter Home in the tab name.

You can name a tab anything you want and if you have a lot of properties it can be useful to add multiple tabs.

", + "view": "tabName" }, { - element: "[data-element='property-add']", - title: "Add a property", - content: "

Properties are the different input fields on a content page.

On our Home Page we wan't to add a welcome text.

Click Add property to open the property dialog.

", - event: "click" + "element": "[data-element='property-add']", + "title": "Add a property", + "content": "

Properties are the different input fields on a content page.

On our Home Page we wan't to add a welcome text.

Click Add property to open the property dialog.

", + "event": "click" }, { - element: "[data-element~='overlay-property-settings'] [data-element='property-name']", - title: "Name the property", - content: "Enter Welcome Text as the name for the property.", - view: "propertyname" + "element": "[data-element~='overlay-property-settings'] [data-element='property-name']", + "title": "Name the property", + "content": "Enter Welcome Text as the name for the property.", + "view": "propertyname" }, { - element: "[data-element~='overlay-property-settings'] [data-element='property-description']", - title: "Enter a description", - content: "

A description will help to fill in the right content.

Enter a description for the property editor. It could be:

Write a nice introduction text so the visitors feel welcome

" + "element": "[data-element~='overlay-property-settings'] [data-element='property-description']", + "title": "Enter a description", + "content": "

A description will help to fill in the right content.

Enter a description for the property editor. It could be:

Write a nice introduction text so the visitors feel welcome

" }, { - element: "[data-element~='overlay-property-settings'] [data-element='editor-add']", - title: "Add editor", - content: "When you add an editor you choose what the input method for this property will be. Click Add editor to open the editor picker dialog.", - event: "click" + "element": "[data-element~='overlay-property-settings'] [data-element='editor-add']", + "title": "Add editor", + "content": "When you add an editor you choose what the input method for this property will be. Click Add editor to open the editor picker dialog.", + "event": "click" }, { - element: "[data-element~='overlay-editor-picker']", - elementPreventClick: true, - title: "Editor picker", - content: "

In the editor picker dialog we can pick one of the many build in editor.

You can choose from preconfigured data types (Reuse) or create a new configuration (Available editors)

" + "element": "[data-element~='overlay-editor-picker']", + "elementPreventClick": true, + "title": "Editor picker", + "content": "

In the editor picker dialog we can pick one of the many build in editor.

You can choose from preconfigured data types (Reuse) or create a new configuration (Available editors)

" }, { - element: "[data-element~='overlay-editor-picker'] [data-element='editor-Textarea']", - title: "Select editor", - content: "Select the Textarea editor. This will add a textarea to the Welcome Text property.", - event: "click" + "element": "[data-element~='overlay-editor-picker'] [data-element='editor-Textarea']", + "title": "Select editor", + "content": "Select the Textarea editor. This will add a textarea to the Welcome Text property.", + "event": "click" }, { - element: "[data-element~='overlay-editor-settings']", - elementPreventClick: true, - title: "Editor settings", - content: "Each property editor can have individual settings. For the textarea editor you can set a charachter limit but in this case it is not needed" + "element": "[data-element~='overlay-editor-settings']", + "elementPreventClick": true, + "title": "Editor settings", + "content": "Each property editor can have individual settings. For the textarea editor you can set a charachter limit but in this case it is not needed" }, { - element: "[data-element~='overlay-editor-settings'] [data-element='button-overlaySubmit']", - title: "Save editor", - content: "Click Submit to save the editor.", - event: "click" + "element": "[data-element~='overlay-editor-settings'] [data-element='button-overlaySubmit']", + "title": "Save editor", + "content": "Click Submit to save the editor.", + "event": "click" }, { - element: "[data-element~='overlay-property-settings'] [data-element='button-overlaySubmit']", - title: "Add property to document type", - content: "Click Submit to add the property to the document type.", - event: "click" + "element": "[data-element~='overlay-property-settings'] [data-element='button-overlaySubmit']", + "title": "Add property to document type", + "content": "Click Submit to add the property to the document type.", + "event": "click" }, { - element: "[data-element='button-save']", - title: "Save the document type", - content: "All we need now is to save the document type. Click Save to create and save your new document type.", - event: "click" + "element": "[data-element='button-save']", + "title": "Save the document type", + "content": "All we need now is to save the document type. Click Save to create and save your new document type.", + "event": "click" } ] }, @@ -202,46 +202,46 @@ "group": "Getting Started", "steps": [ { - title: "Creating your first content node", - content: "

In this tour you will learn how to create the home page for your website. It will use the Home Page Document type you created in the previous tour.

", - type: "intro" + "title": "Creating your first content node", + "content": "

In this tour you will learn how to create the home page for your website. It will use the Home Page Document type you created in the previous tour.

", + "type": "intro" }, { - element: "#applications [data-element='section-content']", - title: "Navigate to the Content section", - content: "

In the Content section you can create and manage the content of the website.

The Content section contains the content of your website. Content is displayed as nodes in the content tree.

", - event: "click", - backdropOpacity: 0.6 + "element": "#applications [data-element='section-content']", + "title": "Navigate to the Content section", + "content": "

In the Content section you can create and manage the content of the website.

The Content section contains the content of your website. Content is displayed as nodes in the content tree.

", + "event": "click", + "backdropOpacity": 0.6 }, { - element: "[data-element='tree-root']", - title: "Open context menu", - content: "

Open the context menu by hovering the root of the content section.

Now click the three small dots to the right.

", - event: "click", - eventElement: "[data-element='tree-root'] [data-element='tree-item-options']" + "element": "[data-element='tree-root']", + "title": "Open context menu", + "content": "

Open the context menu by hovering the root of the content section.

Now click the three small dots to the right.

", + "event": "click", + "eventElement": "[data-element='tree-root'] [data-element='tree-item-options']" }, { - element: "[data-element='action-create-homePage']", - title: "Create Home page", - content: "

The context menu shows you all the actions that are available on a node

Click on Home Page to create a new page of type Home Page.

", - event: "click" + "element": "[data-element='action-create-homePage']", + "title": "Create Home page", + "content": "

The context menu shows you all the actions that are available on a node

Click on Home Page to create a new page of type Home Page.

", + "event": "click" }, { - element: "[data-element='editor-content'] [data-element='editor-name-field']", - title: "Give your new page a name", - content: "

Our new page needs a name. Enter Home in the field and click Next.

", - view: "nodename" + "element": "[data-element='editor-content'] [data-element='editor-name-field']", + "title": "Give your new page a name", + "content": "

Our new page needs a name. Enter Home in the field and click Next.

", + "view": "nodename" }, { - element: "[data-element='editor-content'] [data-element='property-welcomeText']", - title: "Add a welcome text", - content: "

Add content to the Welcome Text field

If you don't have any ideas here is a start:

I am learning Umbraco. High Five I Rock #H5IR
.

" + "element": "[data-element='editor-content'] [data-element='property-welcomeText']", + "title": "Add a welcome text", + "content": "

Add content to the Welcome Text field

If you don't have any ideas here is a start:

I am learning Umbraco. High Five I Rock #H5IR
.

" }, { - element: "[data-element='editor-content'] [data-element='button-saveAndPublish']", - title: "Save and Publish", - content: "

Now click the Save and publish button to save and publish your changes.

", - event: "click" + "element": "[data-element='editor-content'] [data-element='button-saveAndPublish']", + "title": "Save and Publish", + "content": "

Now click the Save and publish button to save and publish your changes.

", + "event": "click" } ] }, @@ -251,42 +251,42 @@ "group": "Getting Started", "steps": [ { - title: "Render your content in a template", - content: "

Templating in Umbraco builds on the concept of Razor Views from asp.net MVC. - This tour is a sneak peak on how to write templates in Umbraco.

In this tour you will learn how to render content from the Home Page document type so you can see the content added to our Home content page.

", - type: "intro" + "title": "Render your content in a template", + "content": "

Templating in Umbraco builds on the concept of Razor Views from asp.net MVC. - This tour is a sneak peak on how to write templates in Umbraco.

In this tour you will learn how to render content from the Home Page document type so you can see the content added to our Home content page.

", + "type": "intro" }, { - element: "#applications [data-element='section-settings']", - title: "Navigate to the Settings section", - content: "

In the Settings section you will find all the templates

It is of course also possible to edit all your code files in your favorite code editor.

", - event: "click", - backdropOpacity: 0.6 + "element": "#applications [data-element='section-settings']", + "title": "Navigate to the Settings section", + "content": "

In the Settings section you will find all the templates

It is of course also possible to edit all your code files in your favorite code editor.

", + "event": "click", + "backdropOpacity": 0.6 }, { - element: "#tree [data-element='tree-item-templates']", - title: "Expand the Templates node", - content: "

To see all our templates click the small triangle to the left of the templates node.

", - event: "click", - eventElement: "#tree [data-element='tree-item-templates'] [data-element='tree-item-expand']", - view: "templatetree" + "element": "#tree [data-element='tree-item-templates']", + "title": "Expand the Templates node", + "content": "

To see all our templates click the small triangle to the left of the templates node.

", + "event": "click", + "eventElement": "#tree [data-element='tree-item-templates'] [data-element='tree-item-expand']", + "view": "templatetree" }, { - element: "#tree [data-element='tree-item-templates'] [data-element='tree-item-Home Page']", - title: "Open Home template", - content: "

Click the Home Page template to open and edit it.

", - eventElement: "#tree [data-element='tree-item-templates'] [data-element='tree-item-Home Page'] a.umb-tree-item__label", - event: "click" + "element": "#tree [data-element='tree-item-templates'] [data-element='tree-item-Home Page']", + "title": "Open Home template", + "content": "

Click the Home Page template to open and edit it.

", + "eventElement": "#tree [data-element='tree-item-templates'] [data-element='tree-item-Home Page'] a.umb-tree-item__label", + "event": "click" }, { - element: "[data-element='editor-templates'] [data-element='code-editor']", - title: "Edit template", - content: '

The template can be edited here or in your favorite code editor.

To render the field from the document type add the following to the template:

<h1>@Model.Content.Name</h1>
<p>@Model.Content.WelcomeText</p>

' + "element": "[data-element='editor-templates'] [data-element='code-editor']", + "title": "Edit template", + "content": "

The template can be edited here or in your favorite code editor.

To render the field from the document type add the following to the template:

<h1>@Model.Content.Name</h1>
<p>@Model.Content.WelcomeText</p>

" }, { - element: "[data-element='editor-templates'] [data-element='button-save']", - title: "Save the template", - content: "Click the Save button and your template will be saved.", - event: "click" + "element": "[data-element='editor-templates'] [data-element='button-save']", + "title": "Save the template", + "content": "Click the Save button and your template will be saved.", + "event": "click" } ] }, @@ -296,36 +296,36 @@ "group": "Getting Started", "steps": [ { - title: "View your Umbraco site", - content: "

Our three main components to a page is done: Document type, Template, and Content - it is now time to see the result.

In this tour you will learn how to see your published website.

", - type: "intro" + "title": "View your Umbraco site", + "content": "

Our three main components to a page is done: Document type, Template, and Content - it is now time to see the result.

In this tour you will learn how to see your published website.

", + "type": "intro" }, { - element: "#applications [data-element='section-content']", - title: "Navigate to the content sections", - content: "In the Content section you will find the content of our website.", - event: "click", - backdropOpacity: 0.6 + "element": "#applications [data-element='section-content']", + "title": "Navigate to the content sections", + "content": "In the Content section you will find the content of our website.", + "event": "click", + "backdropOpacity": 0.6 }, { - element: "#tree [data-element='tree-item-Home']", - title: "Open the Home page", - content: "

Click the Home page to open it

", - event: "click", - eventElement: "#tree [data-element='tree-item-Home'] a.umb-tree-item__label" + "element": "#tree [data-element='tree-item-Home']", + "title": "Open the Home page", + "content": "

Click the Home page to open it

", + "event": "click", + "eventElement": "#tree [data-element='tree-item-Home'] a.umb-tree-item__label" }, { - element: "[data-element='editor-content'] [data-element='tab-_umb_infoTab']", - title: "Info", - content: "

Under the info tab you will find the default information about a content item.

", - event: "click" + "element": "[data-element='editor-content'] [data-element='tab-_umb_infoTab']", + "title": "Info", + "content": "

Under the info tab you will find the default information about a content item.

", + "event": "click" }, { - element: "[data-element='editor-content'] [data-element='node-info-urls']", - title: "Open page", - content: "

Click the Link to document to view your page.

Tip: Click the preview button in the bottom right corner to preview changes without publishing them.

", - event: "click", - eventElement: "[data-element='editor-content'] [data-element='node-info-urls'] a[target='_blank']" + "element": "[data-element='editor-content'] [data-element='node-info-urls']", + "title": "Open page", + "content": "

Click the Link to document to view your page.

Tip: Click the preview button in the bottom right corner to preview changes without publishing them.

", + "event": "click", + "eventElement": "[data-element='editor-content'] [data-element='node-info-urls'] a[target='_blank']" } ] }, @@ -335,84 +335,84 @@ "group": "Getting Started", "steps": [ { - title: "How to use the media library", - content: "

A website would be boring without media content. In Umbraco you can manage all your images, documents, videos etc. in the Media section. Here you can upload and organise your media items and see details about each item.

In this tour you will learn how to upload and organise your Media library in Umbraco. It will also show you how to view details about a specific media item.

", - type: "intro" + "title": "How to use the media library", + "content": "

A website would be boring without media content. In Umbraco you can manage all your images, documents, videos etc. in the Media section. Here you can upload and organise your media items and see details about each item.

In this tour you will learn how to upload and organise your Media library in Umbraco. It will also show you how to view details about a specific media item.

", + "type": "intro" }, { - element: "#applications [data-element='section-media']", - title: "Navigate to the Media section", - content: "The media section is where you manage all your media items.", - event: "click", - backdropOpacity: 0.6 + "element": "#applications [data-element='section-media']", + "title": "Navigate to the Media section", + "content": "The media section is where you manage all your media items.", + "event": "click", + "backdropOpacity": 0.6 }, { - element: "#tree [data-element='tree-root']", - title: "Create a new folder", - content: "

First create a folder for your images. Hover the media root node and click the three small dots on the right side of the item.

", - event: "click", - eventElement: "#tree [data-element='tree-root'] [data-element='tree-item-options']" + "element": "#tree [data-element='tree-root']", + "title": "Create a new folder", + "content": "

First create a folder for your images. Hover the media root node and click the three small dots on the right side of the item.

", + "event": "click", + "eventElement": "#tree [data-element='tree-root'] [data-element='tree-item-options']" }, { - element: "#dialog [data-element='action-Folder']", - title: "Create a new folder", - content: "

Select the Folder option to select the type folder.

", - event: "click" + "element": "#dialog [data-element='action-Folder']", + "title": "Create a new folder", + "content": "

Select the Folder option to select the type folder.

", + "event": "click" }, { - element: "[data-element='editor-media'] [data-element='editor-name-field']", - title: "Enter a name", - content: "

Enter My Images in the field.

" + "element": "[data-element='editor-media'] [data-element='editor-name-field']", + "title": "Enter a name", + "content": "

Enter My Images in the field.

" }, { - element: "[data-element='editor-media'] [data-element='button-save']", - title: "Save the folder", - content: "

Click the Save button to create the new folder

", - event: "click" + "element": "[data-element='editor-media'] [data-element='button-save']", + "title": "Save the folder", + "content": "

Click the Save button to create the new folder

", + "event": "click" }, { - element: "[data-element='editor-media'] [data-element='dropzone']", - title: "Upload images", - content: "

In the upload area you can upload your media items.

Click the Click here to choose files-button and select a couple of images on your computer and upload them.

", - view: "uploadimages" + "element": "[data-element='editor-media'] [data-element='dropzone']", + "title": "Upload images", + "content": "

In the upload area you can upload your media items.

Click the Click here to choose files-button and select a couple of images on your computer and upload them.

", + "view": "uploadimages" }, { - element: "[data-element='editor-media'] [data-element='media-grid-item-0']", - title: "View media item details", - content: "Hover the media item and Click the purple bar to view details about the media item", - event: "click", - eventElement: "[data-element='editor-media'] [data-element='media-grid-item-0'] [data-element='media-grid-item-edit']" + "element": "[data-element='editor-media'] [data-element='media-grid-item-0']", + "title": "View media item details", + "content": "Hover the media item and Click the purple bar to view details about the media item", + "event": "click", + "eventElement": "[data-element='editor-media'] [data-element='media-grid-item-0'] [data-element='media-grid-item-edit']" }, { - element: "[data-element='editor-media'] [data-element='property-umbracoFile']", - title: "The uploaded image", - content: "

Here you can see the image you have uploaded.

" + "element": "[data-element='editor-media'] [data-element='property-umbracoFile']", + "title": "The uploaded image", + "content": "

Here you can see the image you have uploaded.

" }, { - element: "[data-element='editor-media'] [data-element='property-umbracoBytes']", - title: "Image size", - content: "

You will also find other details about the image, like the size.

Media items work in much the same way as content. So you can add extra properties to an image by creating or editing the Media types in the Settings section.

" + "element": "[data-element='editor-media'] [data-element='property-umbracoBytes']", + "title": "Image size", + "content": "

You will also find other details about the image, like the size.

Media items work in much the same way as content. So you can add extra properties to an image by creating or editing the Media types in the Settings section.

" }, { - element: "[data-element='editor-media'] [data-element='tab-_umb_infoTab']", - title: "Info", - content: "Like the content section you can also find default information about the media item. You will find these under the info tab.", - event: "click" + "element": "[data-element='editor-media'] [data-element='tab-_umb_infoTab']", + "title": "Info", + "content": "Like the content section you can also find default information about the media item. You will find these under the info tab.", + "event": "click" }, { - element: "[data-element='editor-media'] [data-element='node-info-urls']", - title: "Link to media", - content: "The path to the media item..." + "element": "[data-element='editor-media'] [data-element='node-info-urls']", + "title": "Link to media", + "content": "The path to the media item..." }, { - element: "[data-element='editor-media'] [data-element='node-info-update-date']", - title: "Last edited", - content: "...and information about when the media item has been created and edited." + "element": "[data-element='editor-media'] [data-element='node-info-update-date']", + "title": "Last edited", + "content": "...and information about when the media item has been created and edited." }, { - element: "[data-element='editor-container']", - title: "Using media items", - content: "You can reference a media item directly in a template by using the path or try adding a Media Picker to a document type property so you can select media items from the content section." + "element": "[data-element='editor-container']", + "title": "Using media items", + "content": "You can reference a media item directly in a template by using the path or try adding a Media Picker to a document type property so you can select media items from the content section." } ] } From 0cfd5773c3c8affbf6da1a21e5fdbd6f54b82146 Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Tue, 9 Jan 2018 14:12:33 +0100 Subject: [PATCH 03/10] set groupOrder on group so we don't order the tours in each group --- .../src/common/services/tour.service.js | 10 +++++++--- .../src/views/common/drawers/help/help.html | 2 +- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js b/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js index 5ad997ce76..97e6f4a3b7 100644 --- a/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js +++ b/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js @@ -219,9 +219,7 @@ var tours = getTours(); setTourStatuses(tours).then(function() { var groupedTours = []; - var sortedTours = _.sortBy(tours, 'groupOrder'); - - sortedTours.forEach(function (item) { + tours.forEach(function (item) { var groupExists = false; var newGroup = { @@ -232,6 +230,9 @@ groupedTours.forEach(function(group){ // extend existing group if it is already added if(group.group === item.group) { + if(item.groupOrder) { + group.groupOrder = item.groupOrder + } groupExists = true; group.tours.push(item) } @@ -240,6 +241,9 @@ // push new group to array if it doesn't exist if(!groupExists) { newGroup.group = item.group; + if(item.groupOrder) { + newGroup.groupOrder = item.groupOrder + } newGroup.tours.push(item); groupedTours.push(newGroup); } diff --git a/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.html b/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.html index e755512b02..58f091a9ab 100644 --- a/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.html +++ b/src/Umbraco.Web.UI.Client/src/views/common/drawers/help/help.html @@ -12,7 +12,7 @@
Tours
-
+
From ea70e18a916075b045c88f88f4969df1f18c9f28 Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Tue, 9 Jan 2018 14:13:27 +0100 Subject: [PATCH 04/10] set "Getting Started"-tour group to order 100 so it is possible be add groups before and after --- .../config/BackOfficeTours/getting-started.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/Umbraco.Web.UI/config/BackOfficeTours/getting-started.json b/src/Umbraco.Web.UI/config/BackOfficeTours/getting-started.json index 72c11f4937..1617bba0cb 100644 --- a/src/Umbraco.Web.UI/config/BackOfficeTours/getting-started.json +++ b/src/Umbraco.Web.UI/config/BackOfficeTours/getting-started.json @@ -3,6 +3,7 @@ "name": "Introduction", "alias": "umbIntroIntroduction", "group": "Getting Started", + "groupOrder": 100, "allowDisable": true, "steps": [ { @@ -86,6 +87,7 @@ "name": "Create document type", "alias": "umbIntroCreateDocType", "group": "Getting Started", + "groupOrder": 100, "steps": [ { "title": "Create your first Document Type", @@ -200,6 +202,7 @@ "name": "Create Content", "alias": "umbIntroCreateContent", "group": "Getting Started", + "groupOrder": 100, "steps": [ { "title": "Creating your first content node", @@ -249,6 +252,7 @@ "name": "Render in template", "alias": "umbIntroRenderInTemplate", "group": "Getting Started", + "groupOrder": 100, "steps": [ { "title": "Render your content in a template", @@ -294,6 +298,7 @@ "name": "View Home page", "alias": "umbIntroViewHomePage", "group": "Getting Started", + "groupOrder": 100, "steps": [ { "title": "View your Umbraco site", @@ -333,6 +338,7 @@ "name": "The Media library", "alias": "umbIntroMediaSection", "group": "Getting Started", + "groupOrder": 100, "steps": [ { "title": "How to use the media library", From a5ec5f46ac74f15575e6ea53c81db6d8a37fa9b8 Mon Sep 17 00:00:00 2001 From: Claus Date: Tue, 9 Jan 2018 15:49:19 +0100 Subject: [PATCH 05/10] filtering out tours. --- src/Umbraco.Web.UI/Umbraco.Web.UI.csproj | 1 + src/Umbraco.Web/Editors/TourController.cs | 47 ++++++++++++++----- src/Umbraco.Web/Editors/TourFilterResolver.cs | 33 +++++++++++++ src/Umbraco.Web/Models/Tour.cs | 22 +++++++++ src/Umbraco.Web/Models/TourStep.cs | 18 +++++++ src/Umbraco.Web/Umbraco.Web.csproj | 3 ++ 6 files changed, 111 insertions(+), 13 deletions(-) create mode 100644 src/Umbraco.Web/Editors/TourFilterResolver.cs create mode 100644 src/Umbraco.Web/Models/Tour.cs create mode 100644 src/Umbraco.Web/Models/TourStep.cs diff --git a/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj b/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj index f522fb467b..49bc478461 100644 --- a/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj +++ b/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj @@ -548,6 +548,7 @@ HealthChecks.config Designer + umbracoSettings.config Designer diff --git a/src/Umbraco.Web/Editors/TourController.cs b/src/Umbraco.Web/Editors/TourController.cs index ad9b6b3430..ed1ed4c9c8 100644 --- a/src/Umbraco.Web/Editors/TourController.cs +++ b/src/Umbraco.Web/Editors/TourController.cs @@ -1,9 +1,13 @@ using System; +using System.Collections.Generic; using System.IO; using System.Linq; -using Newtonsoft.Json.Linq; +using Newtonsoft.Json; +using Umbraco.Core; using Umbraco.Core.Configuration; using Umbraco.Core.IO; +using Umbraco.Core.Logging; +using Umbraco.Web.Models; using Umbraco.Web.Mvc; using Umbraco.Web.WebApi.Filters; using Constants = Umbraco.Core.Constants; @@ -11,29 +15,46 @@ using Constants = Umbraco.Core.Constants; namespace Umbraco.Web.Editors { [PluginController("UmbracoApi")] - [UmbracoApplicationAuthorize(Constants.Applications.Content)] + [UmbracoApplicationAuthorize(Constants.Applications.Content)] public class TourController : UmbracoAuthorizedJsonController { - //TODO: Strongly type this for final release! - public JArray GetTours() + public IEnumerable GetTours() { - //TODO: Add error checking to this for final release! - - var result = new JArray(); + var tours = new List(); if (UmbracoConfig.For.UmbracoSettings().BackOffice.Tours.EnableTours == false) - return result; + return tours; - var tourFiles = Directory.GetFiles( - Path.Combine(IOHelper.MapPath(SystemDirectories.Config), "BackOfficeTours"), "*.json") + var toursPath = Path.Combine(IOHelper.MapPath(SystemDirectories.Config), "BackOfficeTours"); + if (Directory.Exists(toursPath) == false) + return tours; + + var tourFiles = Directory.GetFiles(toursPath, "*.json") .OrderBy(x => x, StringComparer.InvariantCultureIgnoreCase); + var disabledTours = TourFilterResolver.Current.DisabledTours; + foreach (var tourFile in tourFiles) { - var contents = File.ReadAllText(tourFile); - result.Add(JArray.Parse(contents)); + try + { + var contents = File.ReadAllText(tourFile); + var tourArray = JsonConvert.DeserializeObject(contents); + tours.Add(tourArray.Where(x => + disabledTours.Contains(x.Alias, StringComparer.InvariantCultureIgnoreCase) == false).ToArray()); + } + catch (IOException e) + { + Logger.Error("Error while trying to read file: " + tourFile, e); + throw new IOException("Error while trying to read file: " + tourFile, e); + } + catch (JsonReaderException e) + { + Logger.Error("Error while trying to parse content as tour data: " + tourFile, e); + throw new JsonReaderException("Error while trying to parse content as tour data: " + tourFile, e); + } } - return result; + return tours; } } } \ No newline at end of file diff --git a/src/Umbraco.Web/Editors/TourFilterResolver.cs b/src/Umbraco.Web/Editors/TourFilterResolver.cs new file mode 100644 index 0000000000..5eafc19b3c --- /dev/null +++ b/src/Umbraco.Web/Editors/TourFilterResolver.cs @@ -0,0 +1,33 @@ +using System.Collections.Generic; +using System.Linq; + +namespace Umbraco.Web.Editors +{ + //TODO: find out where this should live + public class TourFilterResolver + { + private static TourFilterResolver _current; + + private readonly HashSet _disabledTours; + + public TourFilterResolver() + { + _disabledTours = new HashSet(); + } + + public static TourFilterResolver Current + { + get { return _current ?? (_current = new TourFilterResolver()); } + } + + public void Disable(string tour) + { + _disabledTours.Add(tour); + } + + public IEnumerable DisabledTours + { + get { return _disabledTours.ToArray(); } + } + } +} \ No newline at end of file diff --git a/src/Umbraco.Web/Models/Tour.cs b/src/Umbraco.Web/Models/Tour.cs new file mode 100644 index 0000000000..f130ccfc24 --- /dev/null +++ b/src/Umbraco.Web/Models/Tour.cs @@ -0,0 +1,22 @@ +using System.Runtime.Serialization; + +namespace Umbraco.Web.Models +{ + /// + /// A model representing a tour. + /// + [DataContract(Name = "tour", Namespace = "")] + public class Tour + { + [DataMember(Name = "name")] + public string Name { get; set; } + [DataMember(Name = "alias")] + public string Alias { get; set; } + [DataMember(Name = "group")] + public string Group { get; set; } + [DataMember(Name = "groupOrder")] + public int GroupOrder { get; set; } + [DataMember(Name = "steps")] + public TourStep[] Steps { get; set; } + } +} \ No newline at end of file diff --git a/src/Umbraco.Web/Models/TourStep.cs b/src/Umbraco.Web/Models/TourStep.cs new file mode 100644 index 0000000000..8ed75872d9 --- /dev/null +++ b/src/Umbraco.Web/Models/TourStep.cs @@ -0,0 +1,18 @@ +using System.Runtime.Serialization; + +namespace Umbraco.Web.Models +{ + /// + /// A model representing a step in a tour. + /// + [DataContract(Name = "step", Namespace = "")] + public class TourStep + { + [DataMember(Name = "title")] + public string Title { get; set; } + [DataMember(Name = "content")] + public string Content { get; set; } + [DataMember(Name = "type")] + public string Type { get; set; } + } +} \ No newline at end of file diff --git a/src/Umbraco.Web/Umbraco.Web.csproj b/src/Umbraco.Web/Umbraco.Web.csproj index 326ed3baa9..956071aa40 100644 --- a/src/Umbraco.Web/Umbraco.Web.csproj +++ b/src/Umbraco.Web/Umbraco.Web.csproj @@ -328,6 +328,7 @@ + @@ -428,6 +429,8 @@ + + From 3858656015efaecf01abfdfa41950af661ae2525 Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Tue, 9 Jan 2018 16:15:38 +0100 Subject: [PATCH 06/10] clear tours before registering new tours --- src/Umbraco.Web.UI.Client/src/common/services/tour.service.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js b/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js index 97e6f4a3b7..6b43eddae3 100644 --- a/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js +++ b/src/Umbraco.Web.UI.Client/src/common/services/tour.service.js @@ -17,6 +17,7 @@ * Registers all tours from the server and returns a promise */ function registerAllTours() { + tours = []; return tourResource.getTours().then(function(tourFiles) { angular.forEach(tourFiles, function (tourFile) { angular.forEach(tourFile, function(newTour) { From eb94572361e7c116f8760b4e9ad6dd482fd89eb3 Mon Sep 17 00:00:00 2001 From: Claus Date: Wed, 10 Jan 2018 10:55:46 +0100 Subject: [PATCH 07/10] updating pr to fit with base. --- src/Umbraco.Web/Editors/TourController.cs | 78 +++++++++---------- src/Umbraco.Web/Editors/TourFilterResolver.cs | 2 +- src/Umbraco.Web/Models/BackOfficeTour.cs | 11 +-- src/Umbraco.Web/Models/BackOfficeTourFile.cs | 3 + src/Umbraco.Web/Models/BackOfficeTourStep.cs | 3 + src/Umbraco.Web/Models/Tour.cs | 22 ------ src/Umbraco.Web/Models/TourStep.cs | 18 ----- src/Umbraco.Web/Umbraco.Web.csproj | 2 - 8 files changed, 51 insertions(+), 88 deletions(-) delete mode 100644 src/Umbraco.Web/Models/Tour.cs delete mode 100644 src/Umbraco.Web/Models/TourStep.cs diff --git a/src/Umbraco.Web/Editors/TourController.cs b/src/Umbraco.Web/Editors/TourController.cs index fa1f2a1d2d..2addf0b07e 100644 --- a/src/Umbraco.Web/Editors/TourController.cs +++ b/src/Umbraco.Web/Editors/TourController.cs @@ -2,11 +2,10 @@ using System.Collections.Generic; using System.IO; using System.Linq; -using System.Text.RegularExpressions; using Newtonsoft.Json; -using Newtonsoft.Json.Linq; using Umbraco.Core.Configuration; using Umbraco.Core.IO; +using Umbraco.Core.Logging; using Umbraco.Web.Models; using Umbraco.Web.Mvc; using Umbraco.Web.WebApi.Filters; @@ -25,43 +24,19 @@ namespace Umbraco.Web.Editors if (UmbracoConfig.For.UmbracoSettings().BackOffice.Tours.EnableTours == false) return result; - var toursPath = Path.Combine(IOHelper.MapPath(SystemDirectories.Config), "BackOfficeTours"); - if (Directory.Exists(toursPath) == false) - return result; - - var tourFiles = Directory.GetFiles(toursPath, "*.json") - .OrderBy(x => x, StringComparer.InvariantCultureIgnoreCase); - var disabledTours = TourFilterResolver.Current.DisabledTours; - - var coreTourFiles = Directory.GetFiles( - Path.Combine(IOHelper.MapPath(SystemDirectories.Config), "BackOfficeTours"), "*.json"); - - foreach (var tourFile in coreTourFiles) + //add core tour files + var coreToursPath = Path.Combine(IOHelper.MapPath(SystemDirectories.Config), "BackOfficeTours"); + if (Directory.Exists(coreToursPath)) { - try - { - var contents = File.ReadAllText(tourFile); + var coreTourFiles = Directory.GetFiles(coreToursPath, "*.json"); - result.Add(new BackOfficeTourFile + foreach (var tourFile in coreTourFiles) { - FileName = Path.GetFileNameWithoutExtension(tourFile), - Tours = JsonConvert.DeserializeObject(contents) - }); + TryParseTourFile(tourFile, result); } - catch (IOException e) - { - Logger.Error("Error while trying to read file: " + tourFile, e); - throw new IOException("Error while trying to read file: " + tourFile, e); - } - catch (JsonReaderException e) - { - Logger.Error("Error while trying to parse content as tour data: " + tourFile, e); - throw new JsonReaderException("Error while trying to parse content as tour data: " + tourFile, e); - } - } - //collect all tour files in packges + //collect all tour files in packages foreach (var plugin in Directory.EnumerateDirectories(IOHelper.MapPath(SystemDirectories.AppPlugins))) { var pluginName = Path.GetFileName(plugin.TrimEnd('\\')); @@ -72,13 +47,7 @@ namespace Umbraco.Web.Editors { foreach (var tourFile in Directory.EnumerateFiles(tourDir, "*.json")) { - var contents = File.ReadAllText(tourFile); - result.Add(new BackOfficeTourFile - { - FileName = Path.GetFileNameWithoutExtension(tourFile), - PluginName = pluginName, - Tours = JsonConvert.DeserializeObject(contents) - }); + TryParseTourFile(tourFile, result, pluginName); } } } @@ -86,5 +55,34 @@ namespace Umbraco.Web.Editors return result.OrderBy(x => x.FileName, StringComparer.InvariantCultureIgnoreCase); } + + private void TryParseTourFile(string tourFile, List result, string pluginName = null) + { + try + { + var contents = File.ReadAllText(tourFile); + var tours = JsonConvert.DeserializeObject(contents); + var disabledTours = TourFilterResolver.Current.DisabledTours; + + result.Add(new BackOfficeTourFile + { + FileName = Path.GetFileNameWithoutExtension(tourFile), + PluginName = pluginName, + Tours = tours + .Where(x => disabledTours.Contains(x.Alias, StringComparer.InvariantCultureIgnoreCase) == false) + .ToArray() + }); + } + catch (IOException e) + { + Logger.Error("Error while trying to read file: " + tourFile, e); + throw new IOException("Error while trying to read file: " + tourFile, e); + } + catch (JsonReaderException e) + { + Logger.Error("Error while trying to parse content as tour data: " + tourFile, e); + throw new JsonReaderException("Error while trying to parse content as tour data: " + tourFile, e); + } + } } } \ No newline at end of file diff --git a/src/Umbraco.Web/Editors/TourFilterResolver.cs b/src/Umbraco.Web/Editors/TourFilterResolver.cs index 5eafc19b3c..238df8c6c1 100644 --- a/src/Umbraco.Web/Editors/TourFilterResolver.cs +++ b/src/Umbraco.Web/Editors/TourFilterResolver.cs @@ -25,7 +25,7 @@ namespace Umbraco.Web.Editors _disabledTours.Add(tour); } - public IEnumerable DisabledTours + public string[] DisabledTours { get { return _disabledTours.ToArray(); } } diff --git a/src/Umbraco.Web/Models/BackOfficeTour.cs b/src/Umbraco.Web/Models/BackOfficeTour.cs index 1e0f345b52..a973a92429 100644 --- a/src/Umbraco.Web/Models/BackOfficeTour.cs +++ b/src/Umbraco.Web/Models/BackOfficeTour.cs @@ -1,11 +1,10 @@ -using System; -using System.Linq; -using System.Runtime.Serialization; -using System.Text; -using System.Threading.Tasks; +using System.Runtime.Serialization; namespace Umbraco.Web.Models { + /// + /// A model representing a tour. + /// [DataContract(Name = "tour", Namespace = "")] public class BackOfficeTour { @@ -15,6 +14,8 @@ namespace Umbraco.Web.Models public string Alias { get; set; } [DataMember(Name = "group")] public string Group { get; set; } + [DataMember(Name = "groupOrder")] + public int GroupOrder { get; set; } [DataMember(Name = "allowDisable")] public bool AllowDisable { get; set; } [DataMember(Name = "steps")] diff --git a/src/Umbraco.Web/Models/BackOfficeTourFile.cs b/src/Umbraco.Web/Models/BackOfficeTourFile.cs index 69b35c8088..7291a89ff4 100644 --- a/src/Umbraco.Web/Models/BackOfficeTourFile.cs +++ b/src/Umbraco.Web/Models/BackOfficeTourFile.cs @@ -3,6 +3,9 @@ using System.Runtime.Serialization; namespace Umbraco.Web.Models { + /// + /// A model representing the file used to load a tour. + /// [DataContract(Name = "tourFile", Namespace = "")] public class BackOfficeTourFile { diff --git a/src/Umbraco.Web/Models/BackOfficeTourStep.cs b/src/Umbraco.Web/Models/BackOfficeTourStep.cs index e0371bf4b5..55af21cfd4 100644 --- a/src/Umbraco.Web/Models/BackOfficeTourStep.cs +++ b/src/Umbraco.Web/Models/BackOfficeTourStep.cs @@ -2,6 +2,9 @@ namespace Umbraco.Web.Models { + /// + /// A model representing a step in a tour. + /// [DataContract(Name = "step", Namespace = "")] public class BackOfficeTourStep { diff --git a/src/Umbraco.Web/Models/Tour.cs b/src/Umbraco.Web/Models/Tour.cs deleted file mode 100644 index f130ccfc24..0000000000 --- a/src/Umbraco.Web/Models/Tour.cs +++ /dev/null @@ -1,22 +0,0 @@ -using System.Runtime.Serialization; - -namespace Umbraco.Web.Models -{ - /// - /// A model representing a tour. - /// - [DataContract(Name = "tour", Namespace = "")] - public class Tour - { - [DataMember(Name = "name")] - public string Name { get; set; } - [DataMember(Name = "alias")] - public string Alias { get; set; } - [DataMember(Name = "group")] - public string Group { get; set; } - [DataMember(Name = "groupOrder")] - public int GroupOrder { get; set; } - [DataMember(Name = "steps")] - public TourStep[] Steps { get; set; } - } -} \ No newline at end of file diff --git a/src/Umbraco.Web/Models/TourStep.cs b/src/Umbraco.Web/Models/TourStep.cs deleted file mode 100644 index 8ed75872d9..0000000000 --- a/src/Umbraco.Web/Models/TourStep.cs +++ /dev/null @@ -1,18 +0,0 @@ -using System.Runtime.Serialization; - -namespace Umbraco.Web.Models -{ - /// - /// A model representing a step in a tour. - /// - [DataContract(Name = "step", Namespace = "")] - public class TourStep - { - [DataMember(Name = "title")] - public string Title { get; set; } - [DataMember(Name = "content")] - public string Content { get; set; } - [DataMember(Name = "type")] - public string Type { get; set; } - } -} \ No newline at end of file diff --git a/src/Umbraco.Web/Umbraco.Web.csproj b/src/Umbraco.Web/Umbraco.Web.csproj index 089f024021..d37e4972fd 100644 --- a/src/Umbraco.Web/Umbraco.Web.csproj +++ b/src/Umbraco.Web/Umbraco.Web.csproj @@ -431,9 +431,7 @@ - - From c6443c477fbccdd84e3728b29657977eb7df2e75 Mon Sep 17 00:00:00 2001 From: Claus Date: Wed, 10 Jan 2018 11:13:28 +0100 Subject: [PATCH 08/10] no need to log when throwing - that gets logged. --- src/Umbraco.Web/Editors/TourController.cs | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/Umbraco.Web/Editors/TourController.cs b/src/Umbraco.Web/Editors/TourController.cs index 2addf0b07e..5e43b56159 100644 --- a/src/Umbraco.Web/Editors/TourController.cs +++ b/src/Umbraco.Web/Editors/TourController.cs @@ -75,12 +75,10 @@ namespace Umbraco.Web.Editors } catch (IOException e) { - Logger.Error("Error while trying to read file: " + tourFile, e); throw new IOException("Error while trying to read file: " + tourFile, e); } catch (JsonReaderException e) { - Logger.Error("Error while trying to parse content as tour data: " + tourFile, e); throw new JsonReaderException("Error while trying to parse content as tour data: " + tourFile, e); } } From ce11a377e6b8d91a6a9054efac99626e9299cbd9 Mon Sep 17 00:00:00 2001 From: Claus Date: Wed, 10 Jan 2018 11:37:37 +0100 Subject: [PATCH 09/10] refactor --- src/Umbraco.Web.UI/Umbraco.Web.UI.csproj | 1 - src/Umbraco.Web/Editors/TourController.cs | 1 - src/Umbraco.Web/{Editors => }/TourFilterResolver.cs | 3 +-- src/Umbraco.Web/Umbraco.Web.csproj | 2 +- 4 files changed, 2 insertions(+), 5 deletions(-) rename src/Umbraco.Web/{Editors => }/TourFilterResolver.cs (90%) diff --git a/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj b/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj index dc9939c422..c3d655f194 100644 --- a/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj +++ b/src/Umbraco.Web.UI/Umbraco.Web.UI.csproj @@ -548,7 +548,6 @@ HealthChecks.config Designer - umbracoSettings.config Designer diff --git a/src/Umbraco.Web/Editors/TourController.cs b/src/Umbraco.Web/Editors/TourController.cs index 5e43b56159..3355093659 100644 --- a/src/Umbraco.Web/Editors/TourController.cs +++ b/src/Umbraco.Web/Editors/TourController.cs @@ -5,7 +5,6 @@ using System.Linq; using Newtonsoft.Json; using Umbraco.Core.Configuration; using Umbraco.Core.IO; -using Umbraco.Core.Logging; using Umbraco.Web.Models; using Umbraco.Web.Mvc; using Umbraco.Web.WebApi.Filters; diff --git a/src/Umbraco.Web/Editors/TourFilterResolver.cs b/src/Umbraco.Web/TourFilterResolver.cs similarity index 90% rename from src/Umbraco.Web/Editors/TourFilterResolver.cs rename to src/Umbraco.Web/TourFilterResolver.cs index 238df8c6c1..d30c6b6093 100644 --- a/src/Umbraco.Web/Editors/TourFilterResolver.cs +++ b/src/Umbraco.Web/TourFilterResolver.cs @@ -1,9 +1,8 @@ using System.Collections.Generic; using System.Linq; -namespace Umbraco.Web.Editors +namespace Umbraco.Web { - //TODO: find out where this should live public class TourFilterResolver { private static TourFilterResolver _current; diff --git a/src/Umbraco.Web/Umbraco.Web.csproj b/src/Umbraco.Web/Umbraco.Web.csproj index d37e4972fd..8046e10ff8 100644 --- a/src/Umbraco.Web/Umbraco.Web.csproj +++ b/src/Umbraco.Web/Umbraco.Web.csproj @@ -328,7 +328,7 @@ - + From d7f2041ee984d24b8ccfdd7726d3548610b9fec5 Mon Sep 17 00:00:00 2001 From: Shannon Date: Thu, 11 Jan 2018 18:00:42 +1100 Subject: [PATCH 10/10] Makes the TourFilterResolver a real resolver --- .../ManyObjectsResolverBase.cs | 2 +- src/Umbraco.Web/Editors/TourController.cs | 56 +++++++++++--- .../Models/BackOfficeTourFilter.cs | 61 +++++++++++++++ src/Umbraco.Web/TourFilterResolver.cs | 75 +++++++++++++++---- src/Umbraco.Web/Umbraco.Web.csproj | 1 + src/Umbraco.Web/WebBootManager.cs | 2 + 6 files changed, 172 insertions(+), 25 deletions(-) create mode 100644 src/Umbraco.Web/Models/BackOfficeTourFilter.cs diff --git a/src/Umbraco.Core/ObjectResolution/ManyObjectsResolverBase.cs b/src/Umbraco.Core/ObjectResolution/ManyObjectsResolverBase.cs index ad35b81ffb..6b64172633 100644 --- a/src/Umbraco.Core/ObjectResolution/ManyObjectsResolverBase.cs +++ b/src/Umbraco.Core/ObjectResolution/ManyObjectsResolverBase.cs @@ -394,7 +394,7 @@ namespace Umbraco.Core.ObjectResolution /// WARNING! Do not use this unless you know what you are doing, clear all types registered and instances /// created. Typically only used if a resolver is no longer used in an application and memory is to be GC'd /// - internal void ResetCollections() + internal virtual void ResetCollections() { using (new WriteLock(_lock)) { diff --git a/src/Umbraco.Web/Editors/TourController.cs b/src/Umbraco.Web/Editors/TourController.cs index 3355093659..b0677ed78e 100644 --- a/src/Umbraco.Web/Editors/TourController.cs +++ b/src/Umbraco.Web/Editors/TourController.cs @@ -23,15 +23,21 @@ namespace Umbraco.Web.Editors if (UmbracoConfig.For.UmbracoSettings().BackOffice.Tours.EnableTours == false) return result; + var filters = TourFilterResolver.Current.Filters.ToList(); + + //get all filters that will be applied to all tour aliases + var aliasOnlyFilters = filters.Where(x => x.PluginName == null && x.TourFileName == null).ToList(); + + //don't pass in any filters for core tours that have a plugin name assigned + var nonPluginFilters = filters.Where(x => x.PluginName == null).ToList(); + //add core tour files var coreToursPath = Path.Combine(IOHelper.MapPath(SystemDirectories.Config), "BackOfficeTours"); if (Directory.Exists(coreToursPath)) { - var coreTourFiles = Directory.GetFiles(coreToursPath, "*.json"); - - foreach (var tourFile in coreTourFiles) + foreach (var tourFile in Directory.EnumerateFiles(coreToursPath, "*.json")) { - TryParseTourFile(tourFile, result); + TryParseTourFile(tourFile, result, nonPluginFilters, aliasOnlyFilters); } } @@ -39,6 +45,14 @@ namespace Umbraco.Web.Editors foreach (var plugin in Directory.EnumerateDirectories(IOHelper.MapPath(SystemDirectories.AppPlugins))) { var pluginName = Path.GetFileName(plugin.TrimEnd('\\')); + var pluginFilters = filters.Where(x => x.PluginName != null && x.PluginName.IsMatch(pluginName)).ToList(); + + //If there is any filter applied to match the plugin only (no file or tour alias) then ignore the plugin entirely + var isPluginFiltered = pluginFilters.Any(x => x.TourFileName == null && x.TourAlias == null); + if (isPluginFiltered) continue; + + //combine matched package filters with filters not specific to a package + var combinedFilters = nonPluginFilters.Concat(pluginFilters).ToList(); foreach (var backofficeDir in Directory.EnumerateDirectories(plugin, "backoffice")) { @@ -46,7 +60,7 @@ namespace Umbraco.Web.Editors { foreach (var tourFile in Directory.EnumerateFiles(tourDir, "*.json")) { - TryParseTourFile(tourFile, result, pluginName); + TryParseTourFile(tourFile, result, combinedFilters, aliasOnlyFilters, pluginName); } } } @@ -55,22 +69,44 @@ namespace Umbraco.Web.Editors return result.OrderBy(x => x.FileName, StringComparer.InvariantCultureIgnoreCase); } - private void TryParseTourFile(string tourFile, List result, string pluginName = null) + private void TryParseTourFile(string tourFile, + ICollection result, + List filters, + List aliasOnlyFilters, + string pluginName = null) { + var fileName = Path.GetFileNameWithoutExtension(tourFile); + if (fileName == null) return; + + //get the filters specific to this file + var fileFilters = filters.Where(x => x.TourFileName != null && x.TourFileName.IsMatch(fileName)).ToList(); + + //If there is any filter applied to match the file only (no tour alias) then ignore the file entirely + var isFileFiltered = fileFilters.Any(x => x.TourAlias == null); + if (isFileFiltered) return; + + //now combine all aliases to filter below + var aliasFilters = aliasOnlyFilters.Concat(filters.Where(x => x.TourAlias != null)) + .Select(x => x.TourAlias) + .ToList(); + try { var contents = File.ReadAllText(tourFile); var tours = JsonConvert.DeserializeObject(contents); - var disabledTours = TourFilterResolver.Current.DisabledTours; - result.Add(new BackOfficeTourFile + var tour = new BackOfficeTourFile { FileName = Path.GetFileNameWithoutExtension(tourFile), PluginName = pluginName, Tours = tours - .Where(x => disabledTours.Contains(x.Alias, StringComparer.InvariantCultureIgnoreCase) == false) + .Where(x => aliasFilters.Count == 0 || aliasFilters.All(filter => filter.IsMatch(x.Alias)) == false) .ToArray() - }); + }; + + //don't add if all of the tours are filtered + if (tour.Tours.Any()) + result.Add(tour); } catch (IOException e) { diff --git a/src/Umbraco.Web/Models/BackOfficeTourFilter.cs b/src/Umbraco.Web/Models/BackOfficeTourFilter.cs new file mode 100644 index 0000000000..994cdb6d29 --- /dev/null +++ b/src/Umbraco.Web/Models/BackOfficeTourFilter.cs @@ -0,0 +1,61 @@ +using System.Text.RegularExpressions; + +namespace Umbraco.Web.Models +{ + public class BackOfficeTourFilter + { + public Regex PluginName { get; private set; } + public Regex TourFileName { get; private set; } + public Regex TourAlias { get; private set; } + + /// + /// Create a filter to filter out a whole plugin's tours + /// + /// + /// + public static BackOfficeTourFilter FilterPlugin(Regex pluginName) + { + return new BackOfficeTourFilter(pluginName, null, null); + } + + /// + /// Create a filter to filter out a whole tour file + /// + /// + /// + public static BackOfficeTourFilter FilterFile(Regex tourFileName) + { + return new BackOfficeTourFilter(null, tourFileName, null); + } + + /// + /// Create a filter to filter out a tour alias, this will filter out the same alias found in all files + /// + /// + /// + public static BackOfficeTourFilter FilterAlias(Regex tourAlias) + { + return new BackOfficeTourFilter(null, null, tourAlias); + } + + /// + /// Constructor to create a tour filter + /// + /// Value to filter out tours by a plugin, can be null + /// Value to filter out a tour file, can be null + /// Value to filter out a tour alias, can be null + /// + /// Depending on what is null will depend on how the filter is applied. + /// If pluginName is not NULL and it's matched then we check if tourFileName is not NULL and it's matched then we check tour alias is not NULL and then match it, + /// if any steps is NULL then the filters upstream are applied. + /// Example, pluginName = "hello", tourFileName="stuff", tourAlias=NULL = we will filter out the tour file "stuff" from the plugin "hello" but not from other plugins if the same file name exists. + /// Example, tourAlias="test.*" = we will filter out all tour aliases that start with the word "test" regardless of the plugin or file name + /// + public BackOfficeTourFilter(Regex pluginName, Regex tourFileName, Regex tourAlias) + { + PluginName = pluginName; + TourFileName = tourFileName; + TourAlias = tourAlias; + } + } +} \ No newline at end of file diff --git a/src/Umbraco.Web/TourFilterResolver.cs b/src/Umbraco.Web/TourFilterResolver.cs index d30c6b6093..586d0cb89f 100644 --- a/src/Umbraco.Web/TourFilterResolver.cs +++ b/src/Umbraco.Web/TourFilterResolver.cs @@ -1,32 +1,79 @@ -using System.Collections.Generic; +using System; +using System.Collections.Generic; using System.Linq; +using Umbraco.Core.Logging; +using Umbraco.Core.ObjectResolution; +using Umbraco.Web.Models; namespace Umbraco.Web { - public class TourFilterResolver + /// + /// Allows for adding filters for tours during startup + /// + public class TourFilterResolver : ManyObjectsResolverBase { - private static TourFilterResolver _current; - - private readonly HashSet _disabledTours; - - public TourFilterResolver() + public TourFilterResolver(IServiceProvider serviceProvider, ILogger logger) : base(serviceProvider, logger) { - _disabledTours = new HashSet(); } - public static TourFilterResolver Current + private readonly HashSet _instances = new HashSet(); + + public IEnumerable Filters { - get { return _current ?? (_current = new TourFilterResolver()); } + get { return Values; } } - public void Disable(string tour) + /// + /// Adds a filter instance + /// + /// + public void AddFilter(BackOfficeTourFilter filter) { - _disabledTours.Add(tour); + using (Resolution.Configuration) + _instances.Add(filter); } - public string[] DisabledTours + /// + /// Removes a filter instance + /// + /// + public void RemoveFilter(BackOfficeTourFilter filter) { - get { return _disabledTours.ToArray(); } + using (Resolution.Configuration) + _instances.Remove(filter); + } + + /// + /// Removes a filter instance based on callback + /// + /// + public void RemoveFilterWhere(Func filter) + { + using (Resolution.Configuration) + _instances.RemoveWhere(new Predicate(filter)); + } + + /// + /// + /// Overridden to return the combined created instances based on the resolved Types and the Concrete values added with AddFilter + /// + /// + protected override IEnumerable CreateInstances() + { + var createdInstances = base.CreateInstances(); + return createdInstances.Concat(_instances); + } + + public override void Clear() + { + base.Clear(); + _instances.Clear(); + } + + internal override void ResetCollections() + { + base.ResetCollections(); + _instances.Clear(); } } } \ No newline at end of file diff --git a/src/Umbraco.Web/Umbraco.Web.csproj b/src/Umbraco.Web/Umbraco.Web.csproj index 8046e10ff8..d2c3918edf 100644 --- a/src/Umbraco.Web/Umbraco.Web.csproj +++ b/src/Umbraco.Web/Umbraco.Web.csproj @@ -328,6 +328,7 @@ + diff --git a/src/Umbraco.Web/WebBootManager.cs b/src/Umbraco.Web/WebBootManager.cs index c38540b6a2..03934992bb 100644 --- a/src/Umbraco.Web/WebBootManager.cs +++ b/src/Umbraco.Web/WebBootManager.cs @@ -353,6 +353,8 @@ namespace Umbraco.Web { base.InitializeResolvers(); + TourFilterResolver.Current = new TourFilterResolver(ServiceProvider, LoggerResolver.Current.Logger); + SearchableTreeResolver.Current = new SearchableTreeResolver(ServiceProvider, LoggerResolver.Current.Logger, ApplicationContext.Services.ApplicationTreeService, () => PluginManager.ResolveSearchableTrees()); XsltExtensionsResolver.Current = new XsltExtensionsResolver(ServiceProvider, LoggerResolver.Current.Logger, () => PluginManager.ResolveXsltExtensions());