[#4656] Refactored project name validation
AJAX validation and validation on submit were not using the same
validation checks. Refactored the validation code so that both use
the same checks and consolidated redundant API methods related to those
checks.
The "extra_name_checks" method is no longer used, and those checks
should be folded into the new, more general "validate_project_shortname"
method.
Signed-off-by: Cory Johns <cjohns@slashdotmedia.com>
diff --git a/Allura/allura/controllers/project.py b/Allura/allura/controllers/project.py
index e5edd80..36c4667 100644
--- a/Allura/allura/controllers/project.py
+++ b/Allura/allura/controllers/project.py
@@ -80,7 +80,8 @@
@expose()
def _lookup(self, pname, *remainder):
pname = unquote(pname)
- if not h.re_project_name.match(pname):
+ provider = plugin.ProjectRegistrationProvider.get()
+ if provider.validate_project_shortname(pname, self.neighborhood):
raise exc.HTTPNotFound, pname
project = M.Project.query.get(shortname=self.prefix + pname, neighborhood_id=self.neighborhood._id)
if project is None and self.prefix == 'u/':
@@ -180,19 +181,9 @@
self.neighborhood))
@expose('json:')
- def check_names(self, project_name='', unix_name=''):
- provider = plugin.ProjectRegistrationProvider.get()
- result = dict()
- try:
- W.add_project.fields['project_name'].validate(project_name, '')
- except Invalid as e:
- result['name_message'] = str(e)
-
- unixname_invalid_err = provider.validate_project_shortname(unix_name,
- self.neighborhood)
- result['unixname_message'] = (unixname_invalid_err or
- provider.name_taken(unix_name, self.neighborhood))
- return result
+ @validate(W.add_project)
+ def check_names(self, **raw_data):
+ return c.form_errors
@h.vardec
@expose()
diff --git a/Allura/allura/lib/plugin.py b/Allura/allura/lib/plugin.py
index c0319f7..111aa77 100644
--- a/Allura/allura/lib/plugin.py
+++ b/Allura/allura/lib/plugin.py
@@ -373,21 +373,8 @@
p = M.Project.query.get(shortname=project_name, neighborhood_id=neighborhood._id)
if p:
return 'This project name is taken.'
- for check in self.extra_name_checks():
- if re.match(str(check[1]),project_name) is not None:
- return check[0]
return False
- def extra_name_checks(self):
- """Return an iterable of ``(error_message, regex)`` tuples.
-
- If user attempts to register a project with a name that matches
- ``regex``, the field will be marked invalid, and ``error_message``
- displayed to the user.
-
- """
- return []
-
def suggest_name(self, project_name, neighborhood):
"""Return a suggested project shortname for the full ``project_name``.
diff --git a/Allura/allura/lib/widgets/forms.py b/Allura/allura/lib/widgets/forms.py
index 9501b70..2312c71 100644
--- a/Allura/allura/lib/widgets/forms.py
+++ b/Allura/allura/lib/widgets/forms.py
@@ -45,12 +45,16 @@
''',
'jinja2')
-class NeighborhoodProjectTakenValidator(fev.FancyValidator):
+class NeighborhoodProjectShortNameValidator(fev.FancyValidator):
def _to_python(self, value, state):
value = h.really_unicode(value or '').encode('utf-8').lower()
neighborhood = M.Neighborhood.query.get(name=state.full_dict['neighborhood'])
- message = plugin.ProjectRegistrationProvider.get().name_taken(value, neighborhood)
+ provider = plugin.ProjectRegistrationProvider.get()
+ message = provider.validate_project_shortname(value, neighborhood)
+ if message:
+ raise formencode.Invalid(message, value, state)
+ message = provider.name_taken(value, neighborhood)
if message:
raise formencode.Invalid(message, value, state)
return value
@@ -779,14 +783,7 @@
V.MaxBytesValidator(max=40)))
project_unixname = ew.InputField(
label='Short Name', field_type='text',
- validator=formencode.All(
- fev.String(not_empty=True),
- fev.MinLength(3),
- fev.MaxLength(15),
- fev.Regex(
- r'^[A-z][-A-z0-9]{2,}$',
- messages={'invalid':'Please use only letters, numbers, and dashes 3-15 characters long.'}),
- NeighborhoodProjectTakenValidator()))
+ validator=NeighborhoodProjectShortNameValidator())
tools = ew.CheckboxSet(name='tools', options=[
## Required for Neighborhood functional tests to pass
ew.Option(label='Wiki', html_value='wiki', selected=True)
@@ -805,12 +802,14 @@
def resources(self):
for r in super(NeighborhoodAddProjectForm, self).resources(): yield r
yield ew.CSSLink('css/add_project.css')
+ neighborhood = g.antispam.enc('neighborhood')
project_name = g.antispam.enc('project_name')
project_unixname = g.antispam.enc('project_unixname')
yield ew.JSScript('''
$(function(){
var $scms = $('input[type=checkbox].scm');
+ var $nbhd_input = $('input[name="%(neighborhood)s"]');
var $name_input = $('input[name="%(project_name)s"]');
var $unixname_input = $('input[name="%(project_unixname)s"]');
var $url_fragment = $('#url_fragment');
@@ -864,12 +863,13 @@
});
var check_names = function() {
var data = {
- 'project_name':$name_input.val(),
- 'unix_name': $unixname_input.val()
+ 'neighborhood': $nbhd_input.val(),
+ 'project_name': $name_input.val(),
+ 'project_unixname': $unixname_input.val()
};
$.getJSON('check_names', data, function(result){
- handle_error($name_input, result.name_message);
- handle_error($unixname_input, result.unixname_message);
+ handle_error($name_input, result.project_name);
+ handle_error($unixname_input, result.project_unixname);
});
};
var manual = false;
@@ -897,7 +897,7 @@
delay(check_names, 500);
});
});
- ''' % dict(project_name=project_name, project_unixname=project_unixname))
+ ''' % dict(neighborhood=neighborhood, project_name=project_name, project_unixname=project_unixname))
class MoveTicketForm(ForgeForm):
