345970 - Avoid using the string 'the web'

Status: RESOLVED FIXED

(Bugzilla :: User Interface, defect)

Description

[timeless]

The Web is probably a proper noun and refers to some strange view of The Internet (also a proper noun).

Bugzilla is software with an html interface for use in web browsers, however it doesn't have to run on The Web, it can instead run on an intranet (not a proper noun). When it runs on an intranet it is generally *not* accessible "from The Web".

The following are OK since they reference things generically:
web server -- a server that can serve web content
web browser -- browser that can render web content
web site -- a place that has web content

The following aren't OK:
the web
web accessible -- this is equivalent to "accessible from the web"

Here are the instances I found (landfill's bugzilla tree doesn't update, so there could be some stale bits):
 206   <para>The most-likely cause is that the <quote>cookiepath</quote> parameter
 207   is not set correctly in the Bugzilla configuration.  You can change this (if
/docs/xml/troubleshooting.xml
 208   you're a Bugzilla administrator) from the editparams.cgi page via the web.
 209   </para>

 176     <section id="security-webserver-access">
 177     <title>Disabling Remote Access to Bugzilla Configuration Files</title>
 178     
 179       <para>There are many files that are placed in the Bugzilla directory
/docs/xml/security.xml
 180       area that should not be accessable from the web. Because of the way
 181       Bugzilla is currently layed out, the list of what should and should not
 182       be accessible is rather complicated. A new installation method is
 183       currently in the works which should solve this by allowing files that
 184       shouldn't be accessible from the web to be placed in a directory outside
 185       the webroot. See 

/docs/xml/installation.xml, line 199 -- <para>Once all the files are in a web accessible directory, make that

/checksetup.pl, line 1070 -- # duplicates.xul and must be loadable over the web

/template/en/default/global/user-error.html.tmpl, line 426 -- We recommend that you store your attachment elsewhere on the web,

In a lot of cases "using a web browser" is probably a valid substitution. This bug is obviously not important, but we should probably try to enforce this rule (eventually adding 'the web' and maybe 'web accessible' to the spelling error list).

Comment 1

[Max Kanat-Alexander]

I think that sometimes it's fine, even if it's not exactly correct. For example, this sentence seems OK:

> you're a Bugzilla administrator) from the editparams.cgi page via the web

At the worst, we can replace it with "web interface." In fact, that might even be on the next line.

Comment 2

[Jeffrey Hulten]

I am seeing use of both 'webserver' and 'web server'.  Does anyone have a preference?

Comment 3

[Jeffrey Hulten]

Attachment: Inital changes for use of 'the web'

Comment 4

[Jeffrey Hulten]

Comment on attachment 231367 [details] [diff] [review]
Inital changes for use of 'the web'

Messed up my search.  Trying again.

Comment 5

[Jeffrey Hulten]

Attachment: This should cover all files. Also normalized use of 'web server' instead of 'webserver'

Comment 6

[timeless]

Comment on attachment 231369 [details] [diff] [review]
This should cover all files.  Also normalized use of 'web server' instead of 'webserver'

+# duplicates.xul and must be accessible on the web server
- i'd use "from" instead of "on" - this occurs a couple of times.

don't use tabs.

you'll need to post a new patch so that someone can commit this.

Comment 7

[Frédéric Buclin]

Jeffrey: request approval when you have updated your patch per timeless' comments.

Comment 8

[Jeffrey Hulten]

Attachment: Corrected tab vs space indent.

Comment 9

[Jeffrey Hulten]

*** Bug 345971 has been marked as a duplicate of this bug. ***

Comment 10

[Jeffrey Hulten]

Attachment: Made consistent use of 'from the web server' instead of 'on the web server'

Comment 11

[timeless]

Comment on attachment 231382 [details] [diff] [review]
Made consistent use of 'from the web server' instead of 'on the web server'

> the web servers document directories. See

I think this should be we server's :)

Comment 12

[Frédéric Buclin]

The patch hasn't been comitted yet. Reopening!

Comment 13

[Frédéric Buclin]

The patch doesn't apply cleanly:

Hunk #1 FAILED at 149.
1 out of 1 hunk FAILED -- saving rejects to file Bugzilla/Install/Filesystem.pm.rej

Hunk #2 FAILED at 75.
1 out of 3 hunks FAILED -- saving rejects to file docs/xml/troubleshooting.xml.rej

Could you make sure your patch isn't conflicting with some recent checkin?

Comment 14

[Frédéric Buclin]

This bug has been approved 3 months ago but the patch has never been committed and is bitrotten as mentioned in comment 13. Update the patch, ask someone for review, and then request approval again when you get this review.

Comment 15

[Frédéric Buclin]

The trunk is now frozen -> TM: ---

Comment 16

[timeless]

Attachment: updated

Comment 17

[Frédéric Buclin]

Comment on attachment 273310 [details] [diff] [review]
updated

>Index: docs/xml/security.xml

>+        be accessible is rather complicated. A new installation method is
>+        currently in the works which should solve this by allowing files that
>+        shouldn't be accessible on the web server to be placed in a directory outside
>+        the web servers document directories. See 
>+        <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=44659">bug 44659</ulink>
>+        for more information.

This bug has been resolved as WONTFIX! So this comment doesn't make sense.



>Index: template/en/default/global/messages.html.tmpl

>     decreased security.  If you experience problems running [% terms.Bugzilla %]
>     scripts, log in as [% constants.ROOT_USER FILTER html %] and re-run this script, become a 
>     member of the group, or remove the value of the "webservergroup" parameter.
>+    Note that any warnings about "uninitialized values" that you may see
>+    below are caused by this.

Huh??? Max, is that true?

Comment 18

[timeless]

Attachment: without bad merges

Comment 19

[Frédéric Buclin]

Comment on attachment 273342 [details] [diff] [review]
without bad merges

Looks good. r=LpSolit

Comment 20

[timeless]

Comment on attachment 273342 [details] [diff] [review]
without bad merges

mozilla/webtools/bugzilla/testserver.pl 	1.17
mozilla/webtools/bugzilla/Bugzilla/Attachment.pm 	1.48
mozilla/webtools/bugzilla/Bugzilla/CGI.pm 	1.33
mozilla/webtools/bugzilla/Bugzilla/Constants.pm 	1.73
mozilla/webtools/bugzilla/Bugzilla/Install/Filesystem.pm 	1.21
mozilla/webtools/bugzilla/Bugzilla/Install/Localconfig.pm 	1.9
mozilla/webtools/bugzilla/docs/xml/installation.xml 	1.139
mozilla/webtools/bugzilla/docs/xml/security.xml 	1.17
mozilla/webtools/bugzilla/docs/xml/troubleshooting.xml 	1.13
mozilla/webtools/bugzilla/template/en/default/global/messages.html.tmpl 	1.59
mozilla/webtools/bugzilla/template/en/default/global/user-error.html.tmpl 	1.222