-
Notifications
You must be signed in to change notification settings - Fork 414
/
user_item.py
416 lines (370 loc) · 14.8 KB
/
user_item.py
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
import io
import logging
import xml.etree.ElementTree as ET
from datetime import datetime
from enum import IntEnum
from defusedxml.ElementTree import fromstring
from .exceptions import UnpopulatedPropertyError
from .property_decorators import (
property_is_enum,
property_not_empty,
)
from .reference_item import ResourceReference
from ..datetime_helpers import parse_datetime
from typing import Dict, List, Optional, TYPE_CHECKING, Tuple
if TYPE_CHECKING:
from ..server.pager import Pager
class UserItem(object):
tag_name: str = "user"
class Roles:
Interactor = "Interactor"
Publisher = "Publisher"
ServerAdministrator = "ServerAdministrator"
SiteAdministrator = "SiteAdministrator"
Unlicensed = "Unlicensed"
UnlicensedWithPublish = "UnlicensedWithPublish"
Viewer = "Viewer"
ViewerWithPublish = "ViewerWithPublish"
Guest = "Guest"
Creator = "Creator"
Explorer = "Explorer"
ExplorerCanPublish = "ExplorerCanPublish"
ReadOnly = "ReadOnly"
SiteAdministratorCreator = "SiteAdministratorCreator"
SiteAdministratorExplorer = "SiteAdministratorExplorer"
# Online only
SupportUser = "SupportUser"
class Auth:
OpenID = "OpenID"
SAML = "SAML"
ServerDefault = "ServerDefault"
def __init__(
self, name: Optional[str] = None, site_role: Optional[str] = None, auth_setting: Optional[str] = None
) -> None:
self._auth_setting: Optional[str] = None
self._domain_name: Optional[str] = None
self._external_auth_user_id: Optional[str] = None
self._id: Optional[str] = None
self._last_login: Optional[datetime] = None
self._workbooks = None
self._favorites: Optional[Dict[str, List]] = None
self._groups = None
self.email: Optional[str] = None
self.fullname: Optional[str] = None
self.name: Optional[str] = name
self.site_role: Optional[str] = site_role
self.auth_setting: Optional[str] = auth_setting
return None
def __repr__(self) -> str:
str_site_role = self.site_role or "None"
return "<User {} name={} role={}>".format(self.id, self.name, str_site_role)
@property
def auth_setting(self) -> Optional[str]:
return self._auth_setting
@auth_setting.setter
@property_is_enum(Auth)
def auth_setting(self, value):
self._auth_setting = value
@property
def domain_name(self) -> Optional[str]:
return self._domain_name
@property
def external_auth_user_id(self) -> Optional[str]:
return self._external_auth_user_id
@property
def id(self) -> Optional[str]:
return self._id
@property
def last_login(self) -> Optional[datetime]:
return self._last_login
@property
def name(self) -> Optional[str]:
return self._name
@name.setter
@property_not_empty
def name(self, value: str):
self._name = value
# valid: username, domain/username, username@domain, domain/username@email
@staticmethod
def validate_username_or_throw(username) -> None:
if username is None or username == "" or username.strip(" ") == "":
raise AttributeError("Username cannot be empty")
if username.find(" ") >= 0:
raise AttributeError("Username cannot contain spaces")
at_symbol = username.find("@")
if at_symbol >= 0:
username = username[:at_symbol] + "X" + username[at_symbol + 1 :]
if username.find("@") >= 0:
raise AttributeError("Username cannot repeat '@'")
@property
def site_role(self) -> Optional[str]:
return self._site_role
@site_role.setter
@property_is_enum(Roles)
def site_role(self, value):
self._site_role = value
@property
def workbooks(self) -> "Pager":
if self._workbooks is None:
error = "User item must be populated with workbooks first."
raise UnpopulatedPropertyError(error)
return self._workbooks()
@property
def favorites(self) -> Dict[str, List]:
if self._favorites is None:
error = "User item must be populated with favorites first."
raise UnpopulatedPropertyError(error)
return self._favorites
@property
def groups(self) -> "Pager":
if self._groups is None:
error = "User item must be populated with groups first."
raise UnpopulatedPropertyError(error)
return self._groups()
def _set_workbooks(self, workbooks) -> None:
self._workbooks = workbooks
def _set_groups(self, groups) -> None:
self._groups = groups
def _parse_common_tags(self, user_xml, ns) -> "UserItem":
if not isinstance(user_xml, ET.Element):
user_xml = fromstring(user_xml).find(".//t:user", namespaces=ns)
if user_xml is not None:
(
_,
_,
site_role,
_,
_,
fullname,
email,
auth_setting,
_,
) = self._parse_element(user_xml, ns)
self._set_values(None, None, site_role, None, None, fullname, email, auth_setting, None)
return self
def _set_values(
self,
id,
name,
site_role,
last_login,
external_auth_user_id,
fullname,
email,
auth_setting,
domain_name,
):
if id is not None:
self._id = id
if name:
self._name = name
if site_role:
self._site_role = site_role
if last_login:
self._last_login = last_login
if external_auth_user_id:
self._external_auth_user_id = external_auth_user_id
if fullname:
self.fullname = fullname
if email:
self.email = email
if auth_setting:
self._auth_setting = auth_setting
if domain_name:
self._domain_name = domain_name
@classmethod
def from_response(cls, resp, ns) -> List["UserItem"]:
all_user_items = []
parsed_response = fromstring(resp)
all_user_xml = parsed_response.findall(".//t:user", namespaces=ns)
for user_xml in all_user_xml:
(
id,
name,
site_role,
last_login,
external_auth_user_id,
fullname,
email,
auth_setting,
domain_name,
) = cls._parse_element(user_xml, ns)
user_item = cls(name, site_role)
user_item._set_values(
id,
name,
site_role,
last_login,
external_auth_user_id,
fullname,
email,
auth_setting,
domain_name,
)
all_user_items.append(user_item)
return all_user_items
@staticmethod
def as_reference(id_) -> ResourceReference:
return ResourceReference(id_, UserItem.tag_name)
@staticmethod
def _parse_element(user_xml, ns):
id = user_xml.get("id", None)
name = user_xml.get("name", None)
site_role = user_xml.get("siteRole", None)
last_login = parse_datetime(user_xml.get("lastLogin", None))
external_auth_user_id = user_xml.get("externalAuthUserId", None)
fullname = user_xml.get("fullName", None)
email = user_xml.get("email", None)
auth_setting = user_xml.get("authSetting", None)
domain_name = None
domain_elem = user_xml.find(".//t:domain", namespaces=ns)
if domain_elem is not None:
domain_name = domain_elem.get("name", None)
return (
id,
name,
site_role,
last_login,
external_auth_user_id,
fullname,
email,
auth_setting,
domain_name,
)
class CSVImport(object):
"""
This class includes hardcoded options and logic for the CSV file format defined for user import
https://help.tableau.com/current/server/en-us/users_import.htm
"""
# username, password, display_name, license, admin_level, publishing, email, auth type
class ColumnType(IntEnum):
USERNAME = 0
PASS = 1
DISPLAY_NAME = 2
LICENSE = 3 # aka site role
ADMIN = 4
PUBLISHER = 5
EMAIL = 6
AUTH = 7
MAX = 7
# Read a csv line and create a user item populated by the given attributes
@staticmethod
def create_user_from_line(line: str):
if line is None or line is False or line == "\n" or line == "":
return None
line = line.strip().lower()
values: List[str] = list(map(str.strip, line.split(",")))
user = UserItem(values[UserItem.CSVImport.ColumnType.USERNAME])
if len(values) > 1:
if len(values) > UserItem.CSVImport.ColumnType.MAX:
raise ValueError("Too many attributes for user import")
while len(values) <= UserItem.CSVImport.ColumnType.MAX:
values.append("")
site_role = UserItem.CSVImport._evaluate_site_role(
values[UserItem.CSVImport.ColumnType.LICENSE],
values[UserItem.CSVImport.ColumnType.ADMIN],
values[UserItem.CSVImport.ColumnType.PUBLISHER],
)
user._set_values(
None,
values[UserItem.CSVImport.ColumnType.USERNAME],
site_role,
None,
None,
values[UserItem.CSVImport.ColumnType.DISPLAY_NAME],
values[UserItem.CSVImport.ColumnType.EMAIL],
values[UserItem.CSVImport.ColumnType.AUTH],
None,
)
return user
# Read through an entire CSV file meant for user import
# Return the number of valid lines and a list of all the invalid lines
@staticmethod
def validate_file_for_import(csv_file: io.TextIOWrapper, logger) -> Tuple[int, List[str]]:
num_valid_lines = 0
invalid_lines = []
csv_file.seek(0) # set to start of file in case it has been read earlier
line: str = csv_file.readline()
while line and line != "":
try:
# do not print passwords
logger.info("Reading user {}".format(line[:4]))
UserItem.CSVImport._validate_import_line_or_throw(line, logger)
num_valid_lines += 1
except Exception as exc:
logger.info("Error parsing {}: {}".format(line[:4], exc))
invalid_lines.append(line)
line = csv_file.readline()
return num_valid_lines, invalid_lines
# Some fields in the import file are restricted to specific values
# Iterate through each field and validate the given value against hardcoded constraints
@staticmethod
def _validate_import_line_or_throw(incoming, logger) -> None:
_valid_attributes: List[List[str]] = [
[],
[],
[],
["creator", "explorer", "viewer", "unlicensed"], # license
["system", "site", "none", "no"], # admin
["yes", "true", "1", "no", "false", "0"], # publisher
[],
[UserItem.Auth.SAML, UserItem.Auth.OpenID, UserItem.Auth.ServerDefault], # auth
]
line = list(map(str.strip, incoming.split(",")))
if len(line) > UserItem.CSVImport.ColumnType.MAX:
raise AttributeError("Too many attributes in line")
username = line[UserItem.CSVImport.ColumnType.USERNAME.value]
logger.debug("> details - {}".format(username))
UserItem.validate_username_or_throw(username)
for i in range(1, len(line)):
logger.debug("column {}: {}".format(UserItem.CSVImport.ColumnType(i).name, line[i]))
UserItem.CSVImport._validate_attribute_value(
line[i], _valid_attributes[i], UserItem.CSVImport.ColumnType(i)
)
# Given a restricted set of possible values, confirm the item is in that set
@staticmethod
def _validate_attribute_value(item: str, possible_values: List[str], column_type) -> None:
if item is None or item == "":
# value can be empty for any column except user, which is checked elsewhere
return
if item in possible_values or possible_values == []:
return
raise AttributeError("Invalid value {} for {}".format(item, column_type))
# https://help.tableau.com/current/server/en-us/csvguidelines.htm#settings_and_site_roles
# This logic is hardcoded to match the existing rules for import csv files
@staticmethod
def _evaluate_site_role(license_level, admin_level, publisher):
if not license_level or not admin_level or not publisher:
return "Unlicensed"
# ignore case everywhere
license_level = license_level.lower()
admin_level = admin_level.lower()
publisher = publisher.lower()
# don't need to check publisher for system/site admin
if admin_level == "system":
site_role = "SiteAdministrator"
elif admin_level == "site":
if license_level == "creator":
site_role = "SiteAdministratorCreator"
elif license_level == "explorer":
site_role = "SiteAdministratorExplorer"
else:
site_role = "SiteAdministratorExplorer"
else: # if it wasn't 'system' or 'site' then we can treat it as 'none'
if publisher == "yes":
if license_level == "creator":
site_role = "Creator"
elif license_level == "explorer":
site_role = "ExplorerCanPublish"
else:
site_role = "Unlicensed" # is this the expected outcome?
else: # publisher == 'no':
if license_level == "explorer" or license_level == "creator":
site_role = "Explorer"
elif license_level == "viewer":
site_role = "Viewer"
else: # if license_level == 'unlicensed'
site_role = "Unlicensed"
if site_role is None:
site_role = "Unlicensed"
return site_role