Roundup Tracker - Issues

Issue 2550758

Skip NODEFAULT web address in email signature
Type: rfe Severity: normal
Components: Versions:
Status: new
: : rouilj, wking
Priority: : patch

Created on 2012-05-15 23:07 by wking, last changed 2023-05-20 17:39 by rouilj.

File name Uploaded Description Edit Remove
skip-nodefault-web-address-in-email-signature.patch wking, 2012-05-15 23:07
msg4560 Author: [hidden] (wking) Date: 2012-05-15 23:07
If you're only exposing roundup's email interface, it's silly to put a
dummy URL in the email signatures.

Of course, it's a bit awkward to avoid the web interface entirely at
the moment, but it should be possible.
msg7764 Author: [hidden] (rouilj) Date: 2023-05-20 17:39
This handles one of three cases I can see here:

  1) web interface is available for everybody
  2) web interface is restricted to specific users
  3) web interface is disabled

This handles case 3 nicely, but allowing a value of NODEFAULT means that an admin
doesn't have to take any action to disable the web interface. Also the config.ini's
front matter states that this setting must be provided. This also seems a niche
case since, as noted by wking this makes interaction awkward.

Handling case 1, requires no changes. Handling case 2 is trickier. It requires sending
a different email to each user (so [nosy] email_sending = multiple must be set).
For each target user, look up the username and verify that the "Web Access" permission
is provided. Only if it is present add the web URL. I will send an email to the users-lis to 
see if this is a more realistic use case. If so open another ticket.

Regarding implementing this, I think setting:

  web = disabled

(i.e. the literal string 'disabled') as the only way to disable the web setting
is a better choice. It requires affirmative action on the part of the admin and
documents that the web is disabled.

I also considered using a pseudo URL ('http://disabled/') so the the class defined
to validate the web setting won't have to be modified. But that class is used only for
the web url and is not used in other URL config definitions, so changing it makes sense.

This also should allow the changes in email_signature to be simplified from:

          if (not isinstance(base, type('')) or
                not (base.startswith('http://') or
            web = "Configuration Error: TRACKER_WEB isn't a " \
                "fully-qualified URL"
            if not base.endswith('/'):
                base = base + '/'
            web = base + self.classname + issueid


            if (base == 'disable'):
                web = None

with most of the rest of the original patch.

I think changes to require base to match:


or the tracker will error when the config is read. Hence, the prefix/suffix match will
always fail to match. Also I don't think self.db.config.TRACKER_WEB can return
anything except a string anymore. If the TRACKER_WEB is the NODEFAULT object, get raises
an exception.

Note: I am not sure when the config gets read if we are running multiple trackers
via roundup-server or wsgi mode. It's possible these errors trigger only after
a matching URL request comes in but...
Date User Action Args
2023-05-20 17:39:25rouiljsetkeywords: - Blocker
nosy: + rouilj
messages: + msg7764
2022-11-13 15:42:02rouiljsetkeywords: + Blocker
2019-10-13 22:39:41rouiljsettype: rfe
2012-05-15 23:07:35wkingcreate