annotate rhodecode/lib/__init__.py @ 1222:2c246d24eb90 beta

simplified safe_unicode function
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 06 Apr 2011 20:25:51 +0200
parents a671db5bdd58
children f7b24987d5fb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
914
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
1 # -*- coding: utf-8 -*-
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
2 """
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
3 rhodecode.lib.__init__
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
4 ~~~~~~~~~~~~~~~~~~~~~~~
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
5
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
6 Some simple helper functions
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1199
diff changeset
7
914
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
8 :created_on: Jan 5, 2011
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
9 :author: marcink
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1199
diff changeset
10 :copyright: (C) 2009-2010 Marcin Kuzminski <marcin@python-works.com>
914
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
11 :license: GPLv3, see COPYING for more details.
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
12 """
1206
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
13 # This program is free software: you can redistribute it and/or modify
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
14 # it under the terms of the GNU General Public License as published by
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
15 # the Free Software Foundation, either version 3 of the License, or
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
16 # (at your option) any later version.
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1199
diff changeset
17 #
914
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
18 # This program is distributed in the hope that it will be useful,
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
19 # but WITHOUT ANY WARRANTY; without even the implied warranty of
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
21 # GNU General Public License for more details.
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1199
diff changeset
22 #
914
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
23 # You should have received a copy of the GNU General Public License
1206
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1203
diff changeset
24 # along with this program. If not, see <http://www.gnu.org/licenses/>.
914
110a00c181de Added force https option into config files
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
25
1154
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
26 def str2bool(s):
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
27 if s is None:
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
28 return False
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
29 if s in (True, False):
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
30 return s
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
31 s = str(s).strip().lower()
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
32 return s in ('t', 'true', 'y', 'yes', 'on', '1')
1116
716911af91e1 Added api_key into user, api key get's generated again after password change
Marcin Kuzminski <marcin@python-works.com>
parents: 914
diff changeset
33
716911af91e1 Added api_key into user, api key get's generated again after password change
Marcin Kuzminski <marcin@python-works.com>
parents: 914
diff changeset
34 def generate_api_key(username, salt=None):
1154
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
35 """
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
36 Generates uniq API key for given username
1203
6832ef664673 source code cleanup: remove trailing white space, normalize file endings
Marcin Kuzminski <marcin@python-works.com>
parents: 1199
diff changeset
37
1154
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
38 :param username: username as string
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
39 :param salt: salt to hash generate KEY
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
40 """
1116
716911af91e1 Added api_key into user, api key get's generated again after password change
Marcin Kuzminski <marcin@python-works.com>
parents: 914
diff changeset
41 from tempfile import _RandomNameSequence
716911af91e1 Added api_key into user, api key get's generated again after password change
Marcin Kuzminski <marcin@python-works.com>
parents: 914
diff changeset
42 import hashlib
716911af91e1 Added api_key into user, api key get's generated again after password change
Marcin Kuzminski <marcin@python-works.com>
parents: 914
diff changeset
43
716911af91e1 Added api_key into user, api key get's generated again after password change
Marcin Kuzminski <marcin@python-works.com>
parents: 914
diff changeset
44 if salt is None:
716911af91e1 Added api_key into user, api key get's generated again after password change
Marcin Kuzminski <marcin@python-works.com>
parents: 914
diff changeset
45 salt = _RandomNameSequence().next()
716911af91e1 Added api_key into user, api key get's generated again after password change
Marcin Kuzminski <marcin@python-works.com>
parents: 914
diff changeset
46
716911af91e1 Added api_key into user, api key get's generated again after password change
Marcin Kuzminski <marcin@python-works.com>
parents: 914
diff changeset
47 return hashlib.sha1(username + salt).hexdigest()
1154
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
48
1222
2c246d24eb90 simplified safe_unicode function
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
49 def safe_unicode(_str, from_encoding='utf8'):
1154
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
50 """
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
51 safe unicode function. In case of UnicodeDecode error we try to return
1222
2c246d24eb90 simplified safe_unicode function
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
52 unicode with errors replace
2c246d24eb90 simplified safe_unicode function
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
53
2c246d24eb90 simplified safe_unicode function
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
54 :param _str: string to decode
2c246d24eb90 simplified safe_unicode function
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
55 :rtype: unicode
2c246d24eb90 simplified safe_unicode function
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
56 :returns: unicode object
1154
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
57 """
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
58
1199
268fa0b6b2ef Added os.sep in models for better win support
Marcin Kuzminski <marcin@python-works.com>
parents: 1154
diff changeset
59 if isinstance(_str, unicode):
268fa0b6b2ef Added os.sep in models for better win support
Marcin Kuzminski <marcin@python-works.com>
parents: 1154
diff changeset
60 return _str
268fa0b6b2ef Added os.sep in models for better win support
Marcin Kuzminski <marcin@python-works.com>
parents: 1154
diff changeset
61
1154
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
62 try:
1222
2c246d24eb90 simplified safe_unicode function
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
63 u_str = unicode(_str, from_encoding)
1154
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
64 except UnicodeDecodeError:
1222
2c246d24eb90 simplified safe_unicode function
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
65 u_str = unicode(_str, from_encoding, 'replace')
1154
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
66
36fe593dfe4b simplified str2bool, and moved safe_unicode out of helpers since it was not html specific function
Marcin Kuzminski <marcin@python-works.com>
parents: 1135
diff changeset
67 return u_str