WiP: switch e.g. html/javascript template strings with embedded escape codes to raw string

mig/shared/accountreq.py

@@ -1,3 +1,3 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
@@ -20,7 +20,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 # -- END_HEADER ---
 #
@@ -46,14 +46,14 @@
 from mig.shared.base import auth_type_description, canonical_user, \
     client_id_dir, distinguished_name_to_user, fill_distinguished_name, \
     fill_user, force_utf8, force_native_str_rec, get_user_id, mask_creds
 from mig.shared.defaults import peers_fields, peers_filename, \
     pending_peers_filename, keyword_auto, user_db_filename, \
     gdp_distinguished_field
 from mig.shared.fileio import delete_file, make_temp_file
 from mig.shared.notification import notify_user
 from mig.shared.pwcrypto import check_hash, check_scramble
 # Expose some helper variables for functionality backends
 from mig.shared.safeinput import name_extras, password_extras, \
     password_min_len, password_max_len, valid_password_chars, \
     valid_name_chars, dn_max_len, html_escape, validated_input, REJECT_UNSET
 from mig.shared.serial import load, dump, dumps
@@ -63,29 +63,29 @@
 from mig.shared.validstring import valid_email_addresses
 
 
 def account_css_helpers(configuration):
     """CSS to include in the cert/oid account req page header"""
     css = '''
 <link rel="stylesheet" type="text/css" href="/images/css/jquery.accountform.css" media="screen"/>
     '''
     return css
 
 
 def account_js_helpers(configuration, fields):
     """Javascript to include in the cert/oid account req page header"""
     # TODO: change remaining names and messages to fit generic auth account?
     add_import = '''
 <script type="text/javascript" src="/images/js/jquery.form.js"></script>
 <script type="text/javascript" src="/images/js/jquery.accountform.js"></script>
     '''
-    add_init = """
+    add_init = r"""
   /* Helper to define countries for which State field makes sense */
   var enable_state = ['US', 'CA', 'AU'];
   var peers_mandatory = %(peers_mandatory)s;
   var peers_explicit_fields = %(peers_explicit_fields)s;
 
   function rtfm_warn(message) {
       return confirm(message + ': Proceed anyway? (If you read and followed the instructions!)');
   }
   function rtfm_error(message) {
       alert(message + ': Please read and follow the instructions!');
@@ -120,7 +120,7 @@
       }
   }
   function deprecated_email(value) {
       if (value.search('@gmail.com') != -1 || value.search('@yahoo.com') != -1 || value.search('@hotmail.com') != -1) {
           return true;
       } else {
           return false;
@@ -167,7 +167,7 @@
   }
   function check_organization() {
       //alert('#organization_help');
       if ($('#email_field').val().search('.ku.dk') != -1 || $('#email_field').val().search('diku.dk') != -1 || $('#email_field').val().search('nbi.dk') != -1) {
           if ($('#organization_field').val().indexOf(' ') != -1) {
               return rtfm_warn('Organization does not look like an acronym');
           }
@@ -185,7 +185,7 @@
       //alert('#state_help');
       if (enable_state.indexOf($('#country_field').val()) == -1) {
           if ($('#state_field').val() && $('#state_field').val() != 'NA') {
               return rtfm_warn('State only makes sense for '+enable_state.join(', ')+' users');
           }
       }
       return true;
@@ -203,9 +203,9 @@
       //alert('#verifypassword_help');
       if ($('#verifypassword_field').val().length < %(password_min_len)d) {
          return rtfm_warn('Verify password too short');
       } else if ($('#verifypassword_field').val().length > %(password_max_len)d) {
          return rtfm_warn('Verify password too long');
       } else if ($('#password_field').val() != $('#verifypassword_field').val()) {
          return rtfm_warn('Mismatch between password and verify password');
       }
       return true;
@@ -217,7 +217,7 @@
       }
       var base_err = 'One or more peers contact full names must be provided';
       /* NOTE: split on comma and verbatim 'and' with space removal */
       var all_parts = $('#peers_full_name_field').val().trim().split(/\s*,\s*|\s+and\s+/);
       if (all_parts.length < 1) {
           rtfm_error(base_err);
           return false;
@@ -239,7 +239,7 @@
       }
       var base_err = 'One or more peers contact emails must be provided';
       /* NOTE: split on comma and verbatim 'and' with space removal */
       var all_parts = $('#peers_email_field').val().trim().split(/\s*,\s*|\s+and\s+/);
       if (all_parts.length < 1) {
           rtfm_error(base_err);
           return false;
@@ -371,7 +371,7 @@
     return (add_import, add_init, add_ready)
 
 
 def account_request_template(configuration, password=True, default_values={}):
     """A general form template used for various account requests"""
 
     # Require user to explicitly accept terms of use unless overriden
@@ -527,7 +527,7 @@
         comment_pattern = ''
 
     if 'full_name' in configuration.site_peers_explicit_fields:
-        html += """
+        html += r"""
   <div class='form-row single-entry %(show_peers_full_name)s'>
     <div class='col-md-12 mb-3 form-cell'>
       <!-- NOTE: this simple form control just looks for one or more full names.
@@ -544,7 +544,7 @@
   </div>
         """
     if 'email' in configuration.site_peers_explicit_fields:
-        html += """
+        html += r"""
   <div class='form-row single-entry %(show_peers_email)s'>
     <div class='col-md-12 mb-3 form-cell'>
       <!-- NOTE: this simple form control just looks for one or more emails.