forked from ServiceStack/ServiceStack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAutoQueryMetadataFeature.cs
More file actions
272 lines (233 loc) · 10.1 KB
/
AutoQueryMetadataFeature.cs
File metadata and controls
272 lines (233 loc) · 10.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
using System;
using System.Collections.Generic;
using System.Linq;
using ServiceStack.DataAnnotations;
using ServiceStack.NativeTypes;
namespace ServiceStack
{
public class AutoQueryMetadataFeature : IPlugin
{
public AutoQueryViewerConfig AutoQueryViewerConfig { get; set; }
public Action<AutoQueryMetadataResponse> MetadataFilter { get; set; }
public List<Type> ExportTypes { get; set; }
public int? MaxLimit { get; set; }
public AutoQueryMetadataFeature()
{
this.AutoQueryViewerConfig = GetAutoQueryViewerConfigDefaults();
this.ExportTypes = new List<Type> {
typeof(RequestLogEntry)
};
}
internal static AutoQueryViewerConfig GetAutoQueryViewerConfigDefaults()
{
return new AutoQueryViewerConfig
{
Formats = new[] { "json", "xml", "csv" },
ImplicitConventions = new List<AutoQueryConvention>
{
new AutoQueryConvention { Name = "=", Value = "%" },
new AutoQueryConvention { Name = "!=", Value = "%!" },
new AutoQueryConvention { Name = ">=", Value = ">%" },
new AutoQueryConvention { Name = ">", Value = "%>" },
new AutoQueryConvention { Name = "<=", Value = "%<" },
new AutoQueryConvention { Name = "<", Value = "<%" },
new AutoQueryConvention { Name = "In", Value = "%In" },
new AutoQueryConvention { Name = "Between", Value = "%Between" },
new AutoQueryConvention { Name = "Starts With", Value = "%StartsWith", Types = "string" },
new AutoQueryConvention { Name = "Contains", Value = "%Contains", Types = "string" },
new AutoQueryConvention { Name = "Ends With", Value = "%EndsWith", Types = "string" },
}
};
}
public void Register(IAppHost appHost)
{
if (MaxLimit != null)
AutoQueryViewerConfig.MaxLimit = MaxLimit;
appHost.RegisterService<AutoQueryMetadataService>();
}
}
public class AutoQueryViewerConfig
{
/// <summary>
/// The BaseUrl of the ServiceStack instance (inferred)
/// </summary>
public string ServiceBaseUrl { get; set; }
/// <summary>
/// Name of the ServiceStack Instance (inferred)
/// </summary>
public string ServiceName { get; set; }
/// <summary>
/// Textual description of the AutoQuery Services (shown in Home Services list)
/// </summary>
public string ServiceDescription { get; set; }
/// <summary>
/// Icon for this ServiceStack Instance (shown in Home Services list)
/// </summary>
public string ServiceIconUrl { get; set; }
/// <summary>
/// The different Content Type formats to display
/// </summary>
public string[] Formats { get; set; }
/// <summary>
/// The configured MaxLimit for AutoQuery
/// </summary>
public int? MaxLimit { get; set; }
/// <summary>
/// Whether to publish this Service to the public Services registry
/// </summary>
public bool IsPublic { get; set; }
/// <summary>
/// Only show AutoQuery Services attributed with [AutoQueryViewer]
/// </summary>
public bool OnlyShowAnnotatedServices { get; set; }
/// <summary>
/// List of different Search Filters available
/// </summary>
public List<AutoQueryConvention> ImplicitConventions { get; set; }
/// <summary>
/// The Column which should be selected by default
/// </summary>
public string DefaultSearchField { get; set; }
/// <summary>
/// The Query Type filter which should be selected by default
/// </summary>
public string DefaultSearchType { get; set; }
/// <summary>
/// The search text which should be populated by default
/// </summary>
public string DefaultSearchText { get; set; }
/// <summary>
/// Link to your website users can click to find out more about you
/// </summary>
public string BrandUrl { get; set; }
/// <summary>
/// A custom logo or image that users can click on to visit your site
/// </summary>
public string BrandImageUrl { get; set; }
/// <summary>
/// The default color of text
/// </summary>
public string TextColor { get; set; }
/// <summary>
/// The default color of links
/// </summary>
public string LinkColor { get; set; }
/// <summary>
/// The default background color of each screen
/// </summary>
public string BackgroundColor { get; set; }
/// <summary>
/// The default background image of each screen anchored to the bottom left
/// </summary>
public string BackgroundImageUrl { get; set; }
/// <summary>
/// The default icon for each of your AutoQuery Services
/// </summary>
public string IconUrl { get; set; }
}
[Exclude(Feature.Soap)]
[Route("/autoquery/metadata")]
public class AutoQueryMetadata : IReturn<AutoQueryMetadataResponse> { }
public class AutoQueryViewerUserInfo
{
/// <summary>
/// Returns true if the User Is Authenticated
/// </summary>
public bool IsAuthenticated { get; set; }
/// <summary>
/// How many queries are available to this user
/// </summary>
public int QueryCount { get; set; }
}
public class AutoQueryConvention
{
public string Name { get; set; }
public string Value { get; set; }
public string Types { get; set; }
}
public class AutoQueryOperation
{
public string Request { get; set; }
public string From { get; set; }
public string To { get; set; }
}
public class AutoQueryMetadataResponse
{
public AutoQueryViewerConfig Config { get; set; }
public AutoQueryViewerUserInfo UserInfo { get; set; }
public List<AutoQueryOperation> Operations { get; set; }
public List<MetadataType> Types { get; set; }
public ResponseStatus ResponseStatus { get; set; }
}
[Restrict(VisibilityTo = RequestAttributes.None)]
public class AutoQueryMetadataService : Service
{
public INativeTypesMetadata NativeTypesMetadata { get; set; }
public object Any(AutoQueryMetadata request)
{
if (NativeTypesMetadata == null)
throw new NotSupportedException("AutoQueryViewer requries NativeTypesFeature");
var feature = HostContext.GetPlugin<AutoQueryMetadataFeature>();
var config = feature.AutoQueryViewerConfig;
if (config == null)
throw new NotSupportedException("AutoQueryViewerConfig is missing");
if (config.ServiceBaseUrl == null)
config.ServiceBaseUrl = base.Request.ResolveBaseUrl();
if (config.ServiceName == null)
config.ServiceName = HostContext.ServiceName;
var userSession = Request.GetSession();
var typesConfig = NativeTypesMetadata.GetConfig(new TypesMetadata { BaseUrl = Request.GetBaseUrl() });
foreach (var type in feature.ExportTypes)
{
typesConfig.ExportTypes.Add(type);
}
var metadataTypes = NativeTypesMetadata.GetMetadataTypes(Request, typesConfig,
op => HostContext.Metadata.IsAuthorized(op, Request, userSession));
var response = new AutoQueryMetadataResponse {
Config = config,
UserInfo = new AutoQueryViewerUserInfo {
IsAuthenticated = userSession.IsAuthenticated,
},
Operations = new List<AutoQueryOperation>(),
Types = new List<MetadataType>(),
};
var includeTypeNames = new HashSet<string>();
foreach (var op in metadataTypes.Operations)
{
if (op.Request.Inherits != null
&& (op.Request.Inherits.Name.StartsWith("QueryBase`") ||
op.Request.Inherits.Name.StartsWith("QueryDb`") ||
op.Request.Inherits.Name.StartsWith("QueryData`"))
)
{
if (config.OnlyShowAnnotatedServices)
{
var serviceAttrs = op.Request.Attributes.Safe();
var attr = serviceAttrs.FirstOrDefault(x => x.Name + "Attribute" == typeof(AutoQueryViewerAttribute).Name);
if (attr == null)
continue;
}
var inheritArgs = op.Request.Inherits.GenericArgs.Safe().ToArray();
response.Operations.Add(new AutoQueryOperation {
Request = op.Request.Name,
From = inheritArgs.First(),
To = inheritArgs.Last(),
});
response.Types.Add(op.Request);
op.Request.GetReferencedTypeNames().Each(x => includeTypeNames.Add(x));
}
}
var allTypes = metadataTypes.GetAllTypes();
var types = allTypes.Where(x => includeTypeNames.Contains(x.Name)).ToList();
//Add referenced types to type name search
types.SelectMany(x => x.GetReferencedTypeNames()).Each(x => includeTypeNames.Add(x));
//Only need to seek 1-level deep in AutoQuery's (db.LoadSelect)
types = allTypes.Where(x => includeTypeNames.Contains(x.Name)).ToList();
response.Types.AddRange(types);
response.UserInfo.QueryCount = response.Operations.Count;
if (feature.MetadataFilter != null)
feature.MetadataFilter(response);
return response;
}
}
}