Last modified: 2013-06-12 19:35:37 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T49400, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 47400 - Install Extension:Widget to English Wikivoyage
Install Extension:Widget to English Wikivoyage
Status: RESOLVED INVALID
Product: Wikimedia
Classification: Unclassified
Extension setup (Other open bugs)
wmf-deployment
All All
: Normal enhancement with 2 votes (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on:
Blocks: 31235
  Show dependency treegraph
 
Reported: 2013-04-19 08:48 UTC by Nicolas Raoul
Modified: 2013-06-12 19:35 UTC (History)
8 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Nicolas Raoul 2013-04-19 08:48:29 UTC
== Context ==
Embedding maps in articles is a strong point on Wikivoyage's roadmap.
A German/English collaboration has lead to satisfying dynamic maps that show the Wikivoyage-specific Points Of Interest (POI) and can be zoomed/explored, while remaining printable.

== Proof-of-concept ==
The proof-of-concept is working fine on our test server, which consist of Mediawiki 1.20.4 + Extension:Widgets
It can also be seen live here: http://www.mediawikiwidgets.org/VoyageMap
To start using this, we have to ask you for the favor described below:

== Request ==
1) Install http://www.mediawiki.org/wiki/Extension:Widgets on en.wikivoyage.org
2) Restrict editing of the "Widget:" namespace to admins.

== Pledge to only use safe widgets ==
We pledge to not create widgets that would allow editors to embed arbitrary HTML code (risk of XSS).
Instead, we developed a bulletproof widget, whose parameters are escaped and whose URL is hardcoded to the map server: http://www.mediawikiwidgets.org/VoyageMap
It will be the only widget in use.

== Links ==
Community consensus:
http://en.wikivoyage.org/wiki/Wikivoyage:Travellers%27_pub#Proposal
Dynamic maps project:
http://en.wikivoyage.org/wiki/Wikivoyage:Dynamic_maps_Expedition
Sample article (static map for now):
http://en.wikivoyage.org/wiki/Tokyo/Roppongi#See

Thank you very much!
Comment 1 Andre Klapper 2013-04-19 10:04:20 UTC
https://www.mediawiki.org/wiki/Writing_an_extension_for_deployment lists
* Design review
* Code review
* Review for deployment

Have these steps already taken place? (If code review has not taken place yet, this report should be marked as blocking bug 31235.)
Comment 2 Nicolas Raoul 2013-04-19 10:59:05 UTC
We did not write a new extension, we just want to use the existing extension "Extension:Widgets".

Extension:Widgets already has a "Component" in Bugzilla, so I guess it has been accepted somehow?

Extension:Widgets exists since 2008, whereas the review process article only exists since 2011, so maybe the steps were different at the time?

By the way, here is the Git activity:
https://gerrit.wikimedia.org/r/#/q/project:mediawiki/extensions/Widgets,n,z

----------------------------------------

If Extension:Widgets indeed needs review, should we start from the "design review" step?
If yes, can the extensive documentation be considered as the design document? Documentation: http://www.mediawiki.org/wiki/Extension:Widgets
Comment 3 Andre Klapper 2013-04-19 12:27:42 UTC
(In reply to comment #2)
> We did not write a new extension, we just want to use the existing extension
> "Extension:Widgets".

From my point of view the document refers to "for deployment" but I see that the "writing a *new* extension" could be misleading.

> Extension:Widgets already has a "Component" in Bugzilla, so I guess it has
> been accepted somehow?

Getting into Bugzilla has basically no criteria (I'm happy to provide a bugtracker home for any extension) & is unrelated to deployment requirements.

> If Extension:Widgets indeed needs review, should we start from the "design
> review" step?
> If yes, can the extensive documentation be considered as the design document?
> Documentation: http://www.mediawiki.org/wiki/Extension:Widgets

Apart from the document I linked to I don't know much about the extension deployment review process either (and I don't want to create any stop energy, was just pointing to the current process documentation which likely needs an overhaul anyway). 
CC'ing Sumana and Greg who might know better how to proceed from here.
Comment 4 Nicolas Raoul 2013-04-22 03:47:52 UTC
Hello Sumana & Greg,
Information to help your review:

== Goal ==
Allow administrator-defined widgets to be embedded into articles.
For Wikivoyage, we would only allow the VoyageMap widget, example:

{{#widget:VoyageMap
|lat=35.66262
|lon=139.73060
|zoom=16
|lang=en
|article=Tokyo/Roppongi
|width=410
|height=342
}}

== Facts ==
Used on 341 wikis
Has been maintained for 5 years
Active forum

== Source ==
Simple source code, only 200 lines.
Uses the Smarty PHP library for templating.

If you need any other info, please ask.
WikiVoyage is currently facing a lack of differenciation with WikiTravel (from which it forked due to legal threats from host), so unfortunately most visitors continue to use the old site. Having maps on each article as soon as possible would be strategic in changing momentum.
Comment 5 torty3 2013-06-07 05:56:34 UTC
Hi, can we get an update or direction on how to move forward with this? Will we definitely need to write up a code review for deployment?

Thanks.
Comment 6 Andre Klapper 2013-06-07 10:11:29 UTC
Thanks for the reminder. 

Not sure how to push for the code review part as "Widgets" is not yet deployed on any Wikimedia production wiki. 

Sumana, any idea who to assign?
Comment 7 Greg Grossmeier 2013-06-07 16:54:16 UTC
Torty: I have a feeling the Widget extension will not make it through a security and performance review quickly. Are there any other options you could use, something more focused/limited in scope that only does what you need (instead of just using arbitrary raw HTML)?

Relatedly: the foundation is working on setting up our own tile server for OSM maps. Related RT tickets:
https://rt.wikimedia.org/Ticket/Display.html?id=4563
https://rt.wikimedia.org/Ticket/Display.html?id=3989
Comment 8 torty3 2013-06-08 00:51:34 UTC
We did decide on this as one of the quickest and easiest ways to implement them on-wiki (for us at least), although given this roadblock we may look at other ways. What do you think Nicolas?

I think WikiMiniAtlas is instructive since it injects an iframe into the article, but we would prefer something more permanent and more obvious, since I didn't even know about the map features on Wikipedia and maps are undoubtedly even more important on Wikivoyage.

The tickets look like they need a separate login, so I can't access them, but do they look like the ones on WikiMiniAtlas?
Comment 9 Sam Reed (reedy) 2013-06-08 00:53:55 UTC
(In reply to comment #4)
> Simple source code, only 200 lines.
> Uses the Smarty PHP library for templating.

All still needs reviewing though.
Comment 10 Bawolff (Brian Wolff) 2013-06-08 01:06:37 UTC
> 
> The tickets look like they need a separate login, so I can't access them, but
> do they look like the ones on WikiMiniAtlas?

Yeah RT is secret. Only ops folks have access. (Something about they use it to track billing info as well or something like that.
-----------

Wouldn't it make more logical sense to install the maps extension ([[mw:Extension:Maps]]).

/me finds the widget extension a little scary, but that's just my personal pov, and its not up to me

-----

As an aside, technically it is possible to already do this by dynamically inserting the iframe using js in MediaWiki:Common.js
Comment 11 Greg Grossmeier 2013-06-11 16:47:52 UTC
(In reply to comment #9)
> (In reply to comment #4)
> > Simple source code, only 200 lines.
> > Uses the Smarty PHP library for templating.
> 
> All still needs reviewing though.

What Reedy said, and more, to be more explicit: WMF Engineering just doesn't have the time to devote to reviewing/fixing this extension for deployment to our cluster.

(In reply to comment #10)
> Wouldn't it make more logical sense to install the maps extension
> ([[mw:Extension:Maps]]).
> 
> /me finds the widget extension a little scary, but that's just my personal
> pov,
> and its not up to me
> 
> -----
> 
> As an aside, technically it is possible to already do this by dynamically
> inserting the iframe using js in MediaWiki:Common.js

What about these two suggestions from Brian? I'll note that it appears that the Maps extension would also need a review (security and performance) before going onto WMF production, but it might have a better chance.
Comment 12 Nicolas Raoul 2013-06-12 03:14:24 UTC
Brian, Greg:

Thanks for taking the time to write an answer.

1) Extension:Maps can not be used as is. Our map server parses the whole article and inserts markers for each item of the article, which is very different from the way Extension:Maps works. It is not granted that they will accept to modify their extension to accommodate for our special needs.

2) Thanks for suggesting Common.js, it seems to work. So I guess this issue can be closed now.

Cheers!
Nicolas Raoul
Comment 13 Bawolff (Brian Wolff) 2013-06-12 03:23:14 UTC
I'm changing the resolution to resolved INVALID (which isn't quite right, but it was resolved in a way that didn't involve fixing the original request, so shouldn't be called FIXED)

Cheers
Comment 14 Andre Klapper 2013-06-12 19:35:37 UTC
I'd even use "WORKSFORME" maybe, because a workaround was found. :)

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links