-
-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #104 from leekelleher/dev/v1.4.2
Preparing v1.4.2 release
- Loading branch information
Showing
28 changed files
with
450 additions
and
109 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 1.4.1 | ||
| 1.4.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
149 changes: 149 additions & 0 deletions
149
src/Umbraco.Community.Contentment/DataEditors/DataList/DataSources/ExamineDataListSource.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /* Copyright © 2021 Lee Kelleher. | ||
| * This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using Examine; | ||
| using Examine.Search; | ||
| using Umbraco.Core; | ||
| using Umbraco.Core.IO; | ||
| using Umbraco.Core.PropertyEditors; | ||
| using UmbConstants = Umbraco.Core.Constants; | ||
|
|
||
| namespace Umbraco.Community.Contentment.DataEditors | ||
| { | ||
| [Core.Composing.HideFromTypeFinder] | ||
| public sealed class ExamineDataListSource : IDataListSource | ||
| { | ||
| private readonly IExamineManager _examineManager; | ||
|
|
||
| private const string _defaultNameField = "nodeName"; | ||
| private const string _defaultValueField = "__Key"; | ||
| private const string _defaultIconField = "__Icon"; | ||
|
|
||
| public ExamineDataListSource(IExamineManager examineManager) | ||
| { | ||
| _examineManager = examineManager; | ||
| } | ||
|
|
||
| public string Name => "Examine Query"; | ||
|
|
||
| public string Description => "Populate the data source from an Examine query."; | ||
|
|
||
| public string Icon => "icon-search"; | ||
|
|
||
| public OverlaySize OverlaySize => OverlaySize.Small; | ||
|
|
||
| public IEnumerable<ConfigurationField> Fields => new[] | ||
| { | ||
| new ConfigurationField | ||
| { | ||
| Key = "examineIndex", | ||
| Name = "Examine Index", | ||
| Description = "Select the Examine index.", | ||
| View = DropdownListDataListEditor.DataEditorViewPath, | ||
| Config = new Dictionary<string, object> | ||
| { | ||
| { DropdownListDataListEditor.AllowEmpty, Constants.Values.False }, | ||
| { Constants.Conventions.ConfigurationFieldAliases.Items, _examineManager.Indexes.OrderBy(x => x.Name).Select(x => new DataListItem { Name = x.Name.SplitPascalCasing(), Value = x.Name }) }, | ||
| } | ||
| }, | ||
| new NotesConfigurationField(@"<details class=""well well-small""> | ||
| <summary><strong>Do you need help with Lucene query?</strong></summary> | ||
| <div class=""mt3""> | ||
| <p>If you need assistance with Lucene query syntax, please refer to this resource on <a href=""https://our.umbraco.com/documentation/reference/searching/examine/overview-explanation#power-searching-with-raw-lucene-queries"" target=""_blank""><strong>our.umbraco.com</strong></a>.</p> | ||
| </div> | ||
| </details>", true), | ||
| new ConfigurationField | ||
| { | ||
| Key = "luceneQuery", | ||
| Name = "Lucene query", | ||
| Description = "Enter your raw Lucene expression to query Examine with.", | ||
| View = CodeEditorDataEditor.DataEditorViewPath, | ||
| Config = new Dictionary<string, object> | ||
| { | ||
| { CodeEditorConfigurationEditor.Mode, "text" }, | ||
| { CodeEditorConfigurationEditor.MinLines, 1 }, | ||
| { CodeEditorConfigurationEditor.MaxLines, 5 }, | ||
| } | ||
| }, | ||
| new ConfigurationField | ||
| { | ||
| Key = "nameField", | ||
| Name = "Name Field", | ||
| Description = "Enter the field name to select the name from the Examine record.", | ||
| View = "textstring", | ||
| }, | ||
| new ConfigurationField | ||
| { | ||
| Key = "valueField", | ||
| Name = "Value Field", | ||
| Description = "Enter the field name to select the value (key) from the Examine record.", | ||
| View = "textstring", | ||
| }, | ||
| new ConfigurationField | ||
| { | ||
| Key = "iconField", | ||
| Name = "Icon Field", | ||
| Description = "<em>(optional)</em> Enter the field name to select the icon from the Examine record.", | ||
| View = "textstring", | ||
| }, | ||
| new ConfigurationField | ||
| { | ||
| Key = "descriptionField", | ||
| Name = "Description Field", | ||
| Description = "<em>(optional)</em> Enter the field name to select the description from the Examine record.", | ||
| View = "textstring", | ||
| }, | ||
| }; | ||
|
|
||
| public Dictionary<string, object> DefaultValues => new Dictionary<string, object> | ||
| { | ||
| { "examineIndex", UmbConstants.UmbracoIndexes.ExternalIndexName }, | ||
| { "luceneQuery", "+__IndexType:content" }, | ||
| { "nameField", _defaultNameField }, | ||
| { "valueField", _defaultValueField }, | ||
| { "iconField", _defaultIconField }, | ||
| { "descriptionField", string.Empty }, | ||
| }; | ||
|
|
||
| public IEnumerable<DataListItem> GetItems(Dictionary<string, object> config) | ||
| { | ||
| var examineIndex = config.GetValueAs("examineIndex", UmbConstants.UmbracoIndexes.ExternalIndexName); | ||
| if (_examineManager.TryGetIndex(examineIndex, out var index) == true) | ||
| { | ||
| var luceneQuery = config.GetValueAs("luceneQuery", string.Empty); | ||
| if (string.IsNullOrWhiteSpace(luceneQuery) == false) | ||
| { | ||
| var nameField = config.GetValueAs("nameField", _defaultNameField); | ||
| var valueField = config.GetValueAs("valueField", _defaultValueField); | ||
| var iconField = config.GetValueAs("iconField", _defaultIconField); | ||
| var descriptionField = config.GetValueAs("descriptionField", string.Empty); | ||
|
|
||
| var results = index | ||
| .GetSearcher() | ||
| .CreateQuery() | ||
| .NativeQuery(luceneQuery) | ||
| // NOTE: For any `OrderBy` complaints, refer to: https://github.com/Shazwazza/Examine/issues/126 | ||
| .OrderBy(new SortableField(nameField, SortType.String)) | ||
| .Execute(); | ||
|
|
||
| if (results?.TotalItemCount > 0) | ||
| { | ||
| return results.Select(x => new DataListItem | ||
| { | ||
| Name = x.Values.ContainsKey(nameField) == true ? x.Values[nameField] : x.Values[_defaultNameField], | ||
| Value = x.Values.ContainsKey(valueField) == true ? x.Values[valueField] : x.Values[_defaultValueField], | ||
| Icon = x.Values.ContainsKey(iconField) == true ? x.Values[iconField] : x.Values[_defaultIconField], | ||
| Description = x.Values.ContainsKey(descriptionField) == true ? x.Values[descriptionField] : null, | ||
| }); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return Enumerable.Empty<DataListItem>(); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.