Commit graph

379 commits

Author SHA1 Message Date
C. Scott Ananian 7e444d6364 All extensions implement Extension; tags all implement ExtensionTag
Restructure ExtensionTag as an abstract class with default do-nothing
implementations of all methods.  So instead of Translate and LST
not implementing ExtensionTag::toDOM, they inherit the default
implementation which returns false, and that has the same effect.

The intention is to move SerialHandler::fromHTML and SerialHandler::before
into this framework as well.  Every "optional" method should have a default
implementation in the base class which returns false.

Change-Id: I0ad5c714601c0cf0b5189d4d282c67c6b53fc760
2019-07-11 18:46:14 +00:00
C. Scott Ananian b84b71af22 Gallery: shift TSRs in the DOM, rather than fibbing about srcOffset
Passing srcOffsets which don't actually correspond to actual regions of
the source wikitext cause problems in the token offset conversion code.
Instead, parse the wikitext as itself, then adjust the TSRs in the DOM
tree.

Since Gallery isn't ported to PHP (yet), update the
automatically-generated Gallery/index.php.  The newly-added
ContentUtils::shiftDSR() was ported, however.

Change-Id: I28f3d3398930733ae2bcf9759e49c45f93bc7190
2019-06-28 14:10:16 +00:00
C. Scott Ananian c790d125de Convert dsr properties to DomSourceRange instances in PHP port
Change-Id: I7795cedf14e6ff56a31eeaba0a32c3c5c3166f08
2019-06-27 15:35:05 -04:00
Subramanya Sastry 720f1db084 Fix exception handling: Don't catch exceptions and suppress them
* Now that we are in sync land, we don't need to catch exceptions
  and log error messages at multiple places. Let them bubble up
  to the top.

* I noticed this was actually getting in the way of debugging because
  with $env->log unimplemented, I was only getting very generic
  failures instead of the root cause that was being suppressed
  and unlogged.

* There are still a couple of places where we have generic Exception
  catching in place where it does make sense currently. For example,
  we aren't interested in what caused a templatedata fetch to fail.
  We simply fall back to regular serialization - the rationale here is
  that it is better to emit a transclusion without the preferred formatting
  (but syntactically correct) instead of losing the edit altogether.

* Minor unrelated fix in Cite/Ref.php: Use !isset() instead of empty()

Change-Id: Iebff6f37dcd8278185c4a74b72a99b528efa20ff
2019-06-26 15:50:49 -05:00
Subramanya Sastry bc72a99fb2 Minor fixes to Cite port
Change-Id: Iccd6823c572059948e5ad1a7c91d567d39494934
2019-06-26 11:59:48 -05:00
Subramanya Sastry 3f0b81b085 Followup to 31d356a5, 005176a3 and assorted fixes
* Source offset fixes: followup to 31d356a5
  - there were instances of $tsr[0] and $tsr[1] that hadn't
    been converted over to $tsr->start, $tsr->end
  - removed dead code

* Cite fixes: followup ot 005176a3
  - Fixes array / object mixups
  - Bug fix

* html2wt/WikiLinkHandler fixes
  - Protect access to missing properties in data-mw opt list

* Other assorted fixes
  - Added missing typehints and improved doc types
  - Simplified some code patterns
  - Cast extension attributes to object since that ends up
    in data-mw which is a stdclass object.

Change-Id: Idd04b0d3819be3660823047a90330fd1213388cf
2019-06-24 16:56:56 +00:00
Pavel Astakhov 005176a355 Port Cite extension
* All wt2wt, html2wt, and all but one html2html tests pass in
  hybrid mode when entire html2wt code is run in PHP

  Set "Serializer: true" in the html2wt section of phpconfig.yaml

* The single failing html2html test is a <gallery> test which is
  presumably related to the unported <gallery> extension code, but
  not sure. Not investigating it now.

* Update Parsoid Extension API to provide access to extension source
  without exposing internals.

Change-Id: I6d6e21ad2324acfc4306b32c9055d6c088708c48
2019-06-21 16:23:42 -05:00
C. Scott Ananian 4e334fa727 Fix an incorrectly capitalized typeOf in automatically-generated code
Follow up to 04efa43c4c.

Change-Id: I12fa70f002ba65b5a5835ef65a557b6c39782f51
2019-06-20 18:54:13 -04:00
Subramanya Sastry 04efa43c4c s/typeOf/typeof in various files
- git grep is a wonderful thing to help catch identical errors.
- Saw this "bug" first in the cite extension port.
- Turns out this is only a bug on the PHP side since the PHP DOM
  treats attributes in a case-sensitive manner but Domino.js
  treats attributes in a case-insensitive manner.
- Better to use the correct attribute name everywhere.

Change-Id: I3735dc768a10a820b4816c211aa72291df9b1413
2019-06-20 11:46:07 -05:00
Subramanya Sastry 30aaf6574c DOMFragments: Use sealFragment instead of unwrapFragment
* unwrapFragment had a somewhat unusual behavior which could be
  a source of bugs while reasoning with it.

  If undefined, it's default value is true which is contrary
  to how we think of undefined.

* Flipping the polarity of the flag to sealFragment makes the
  semantics easier to reason with and where !empty(..) applies
  more naturally to it.

Change-Id: Ia50cba345f37e815e5f5f95abb452c8eefcf9011
2019-06-13 13:38:20 -05:00
C. Scott Ananian 320d045ee8 Update automatically-generated PHP files w/ latest js2php
Mostly comment formatting improvements, some significant code changes
to the JS side.

Change-Id: I7a8f2105173df74dc09f2024d68268f5dc6fa632
2019-06-05 17:13:34 -04:00
Subramanya Sastry f5c8aacc6e Cite lint handler: Use nextSibling instead of nextNode
* Not sure why nextNode was used in the first place, possibly
  some oversight?

Change-Id: Ied76591947bb7505c59b9a11589a19b13dc58790
2019-05-28 17:30:10 +00:00
Arlo Breault 05cb13ddf9 Make extensions with post-processors return constructors
This allows us to finish the cleanup started in 0b3bb10 and inline
setupProcessors.

Change-Id: Ia7840091607e9a75153031b5db7600d5a0018da6
2019-04-03 18:44:21 +00:00
Arlo Breault 20c627e3f4 Convert cite extension to es6 class structure
Also, runs js2php on these files.

Change-Id: Id8ee13ad536d75f63e0045a21fdfdb667a0df65d
2019-04-03 12:20:41 -04:00
C. Scott Ananian eb70a83eb0 Audit uses of Node#getAttribute() + add missing file to PHP codebase
In PHP, DOMNode#getAttribute() return '' if the attribute is not present,
not null.  Audit our uses and try to either explicitly use `|| ''` (which
will ensure that PHP behaves the same was as JS) or use `hasAttribute`
to explicitly test for the presence of the attribute.

Changes have also been ported to PHP from JS.
Also added src/Wt2Html/PP/Processors/AddMediaInfo.php which was missing.

Change-Id: Ie1ae1df88e4fca70daf97b6f720f28014ebc99ed
2019-03-15 15:48:20 +00:00
C. Scott Ananian 25385a06e8 Apply recent JS changes to automatically-generated PHP port
This applies the JS changes from the following recently-merged patches:

6679c3bf Protect data-object-id attribute
d4e76d5b Fix new linter category to enable code work with templates
e567db8d Tweak storeDataAttribs to suppress DOM nodes in data-parsoid.tmp
16603953 Fix setting dsr on body for genTest
3a84a9dd Fix stashing data attributes for mw:StartTag
22c4a19a Remove redundant dataParsoid call
ed7b0ba0 Fix crasher in newly added linter category
505a357b Linter.js: Add new function to detect the use of links in links
8885b20e Move redlink updating into lib/parse.js
ccfce23d templatedepth is either an int or false
6d1571bd Move language conversion work into lib/parse.js
5a89c7de Avoid serialize/parse of data attributes when treebuilding
021d9958 Rename `document.env` to `document.bag`
c03ba494 Use XMLSerializer on both PHP & JS side in the DOM pass test script
e0c3cca9 Use env.createDocument in lib/api/apiUtils.js
550d3d71 Use a bag-on-the-side implementation for node data
f8de8b25 Add bin/inspectTokenizer.js
db704eea Add ability to splice a PHP transformer into the pipeline
a8be3ad6 Fix crasher in cite extension from accessing data after it's stored
2874f200 Simplify and clean up stops usage
6368265d Add some strategic isElt guards
5ae9553f DRY out transform test runners + tweak genTest to enable that
b0f2adc6 Assert that the .dataobject isn't touched after storing attrs on a node
1ce6a98d Skip separators when looking for the next th/td

Change-Id: I6a66ecb061e7ee7ed53feba1895dd315d9324715
2019-03-05 17:33:32 -05:00
Arlo Breault 550d3d71eb Use a bag-on-the-side implementation for node data
Centralizing where all the docs are created is also useful for T179082

Bug: T204608
Change-Id: I5f0f1d4e696794dc8666edcbf290dea790c06673
2019-02-21 15:13:32 +00:00
Arlo Breault a8be3ad6e4 Fix crasher in cite extension from accessing data after it's stored
Follow up to b0f2adc

Change-Id: I840924ba1ba1b7af963d541c2cb6619543fbe69d
2019-02-19 13:05:10 -05:00
C. Scott Ananian f2948cd170 Skeleton PHP files generated by automatic conversion from JS
Change-Id: I93dbbdb474d37f88e0bab1d810b3dd51304055fd
2019-02-13 12:34:44 -05:00
C. Scott Ananian 11147b88f4 Minor JS fixes to make conversion to PHP better
Change-Id: Ia36dab7c9a0a59df80c582b18cbc5a0a9bf8a36a
2019-02-04 13:39:16 -05:00
Arlo Breault 1855c046ac Add media info in a post-processing pass
The basic idea here is to generate the media structure in the token
stream using a stuffed span with a redlink, as in T169975, and
augmenting the nodes on the DOM once the media info has been fetched.

A redlink is justified as the canonical representation of the media
elements before info is fetched because it's the fallback if fetching
fails and the media type is unknown until the info is retrieved.

Most options are stored in data-mw until the media type is fetched and
it's determined that they're applicable.  This is a bit of a reversion
of how things were done before where inapplicable options were removed
post-facto.

For consistency and styling's sake, figcaptions are now always added to
block figures.

The pass has to be run before generating headings anchor, since that
depends on the text content (ie. redlinks).  This rearranges things in
the post-processor and adds another pass.

The post-processing pass to add media info is run on subpipelines as
well as the top level so that the media info is present in cases where
we embed HTML in data-mw (which is currently skipped by the top level
only passes, except for the cite extension, which has special handling,
see T214994) and to avoid an additional post-processing pass for the
gallery extension, which scales media of packed galleries.  This comes
at the cost of making additional queries for each pipeline and requires
the add media pass to be idempotent.

Filed T214241 for figuring out what to do about data-mw info being
clobbered by template annotations.

The newly failing blacklisted tests are from roundtripping media options
in galleries, which requires a general refactor for support.  See the
FIXMEs added there.

Performance should be expected to regress by the amount of work we're
able to overlap in the async phase of the pipeline while the media info
is being fetched.  Considering a lot of that work is caught up waiting
for the batch to return (other async requests are found in the same
batch), this doesn't turn out to be much in practice in the average
case.

Bug: T153080
Bug: T169975
Change-Id: I856ee962b70cef1f8d49652396ea5264e11a8ade
2019-02-01 13:30:07 -08:00
Subramanya Sastry bf21cf0ce9 Init src/ with .js files copied over with .php extensions
* This initialization lets us do a git log --follow and follow
  git history for that file across the js -> php port boundary.
  This works because git uses content hashes for objects and
  the copied code in the new .php file will have the same content
  hash as the .js file.

* The following directories were skipped
  - ./lib/config/baseconfig
  - ./tests

* The following JS files were skipped
  - ./lib/utils/promise.js
  - ./lib/config/wmf.sitematrix.json

  - ./tools/sync-baseconfig.js
  - ./tools/sync-parserTests.js
  - ./tools/fetch_ve_nowiki_edits.js
  - ./tools/fetch-parserTests.txt.js
  - ./tools/fetch-wmf-sitematrix.js
  - ./tools/compare.linter.results.js
  - ./tools/fetch-revision-data.js
  - ./tools/fetch-wt.js
  - ./tools/regression-testing.js
  - ./tools/build-langconv-fst.js

  - ./bin/server.js

Change-Id: I0b22057c23b72795aebbd66e3abcb627c6858ef3
2019-01-09 11:59:29 -06:00
Subramanya Sastry 59b6621db3 extapi: Stop leaking manager (an impl. detail) to extensions
* Extensions only need config info (env) and potentially abstract
  parsing context (frame).

* Added some FIXMEs about potential future improvements.

Change-Id: Ib4cec4a77ecb96c855798eeb06f7742c5efb0729
2019-01-08 00:21:56 +00:00
Arlo Breault df161e78eb Add helpers to ease binding context when load/storing data attribs
Bug: T209772
Change-Id: Iebe68b179656538955c0c438806a1a724e7d185c
2018-12-18 12:39:04 -05:00
Subramanya Sastry 8a9908abbc Remove .bind() usages in native extension code.
Bug: T205336
Change-Id: I544205d7f32f755c0d0616af404a68ea40f4d2f5
2018-12-07 03:23:31 +00:00
Arlo Breault c1b003553d Move applying about ids from fragment wrappers to extension content
It's only the extension content that needs the about ids.  This matches
b241ac6 where span wrapping was only applied to extension content, and
goes hand-in-hand.  The one necessitates the other.

Fragment wrappers don't need abouts since they don't have siblings and
are represented as a single node.

When we get to unpacking, it's now clear that if the wrapper has an
about id, it came from template encapsulation and would need to be
applied to the top-level nodes in the fragment.  This being true of
all fragment, it lets use get rid of the `isForeignContent` option to
`encapsulateExpansionHTML`, since that no longer serves to distinguish
anything.

Change-Id: Id9faae3d4e3c8771c2de1fb42ba62a7d92d76673
2018-12-06 23:35:07 +00:00
Subramanya Sastry cee1086f35 Update HISTORY.md + bump version numbers to 0.10.0 for deb release
Change-Id: I0be0c80a3f47ba3b1c2f94016bd9304de99388d4
2018-12-05 12:09:26 -05:00
Subramanya Sastry 7bee635f21 Split utils/DOMUtils.js into separate functional units
* DOMUtils was perhaps the biggest kitchen sink utility class we had
  with different classes of utilities.

* The split reflects a clear dependence hierarchy:
  DOMUtils -> DOMDataUtils -> WTUtils -> ContentUtils

  This also seems to reflect a bit in the use patterns.
  Content helpers are not used as much in html2wt.

* DOMUtils now only has DOM utilities that are independent of Parsoid
  and could be useful in another project.

* Moved a couple helpers into WTSUtils.js since they are very narrowly
  scoped to html2wt functionality and are unlikely to be every useful
  elsewhere.

* Moved diffing related utils to html2wt/DiffUtils.js
  - There is still a dependency in development / debug mode when
    doms have to be dumped. I couldn't think of an easy way of
    removing this dependency.

  - But otherwise, DiffUtils is scoped to html2wt use cases only.

* One more circular dependency eliminated.

* All tests pass.

Bug: T208360
Bug: T205333
Change-Id: I522e8b5c7d726706f994386282476102fe35e91e
2018-12-03 14:57:40 -06:00
Arlo Breault 878f6c7937 Unnecessary passing along of "responsive" attribute
These are already set on the first encapsulation node by toDOM.

Change-Id: I1eefdaf94e28222fc44d0be9d017eeab2f70c592
2018-12-03 03:54:26 +00:00
Arlo Breault 26984c0294 Allow extensions to set more options to encapsulateExpansionHTML
The nowiki extension will want to override `isForeignContent` so that
about attributes are omitted on the contents.

Change-Id: Iea28d7a66a90d516226ba9dce4518be6b996d18e
2018-11-29 20:28:54 -05:00
Subramanya Sastry b4d7a158cd Cite: Import Sanitizer from extapi
Change-Id: Ic4cb95d2fbe678641b4496d38295ec8e06269d28
2018-11-21 20:24:48 +00:00
Arlo Breault e644753c6b Introduce a parseTokenContentsToDOM helper
It calls out to a slimmed down parseWikitextToDOM, since only a subset
of that functionality is needed in some extensions, like gallery.

Change-Id: I72e29c4b285fc8cae0207966cc2eddd0fe3ebcf3
2018-11-19 12:20:43 -05:00
Subramanya Sastry 678effaf0e Extension API: Add a html2wtPreprocessor DOM processor stub
* This patch doesn't do any actual work beyond adding the framework
  in place for HTML preprocessing before actual serialization.

Change-Id: I2505f5937657813480abef8ec5da9d765a953e29
2018-11-07 17:22:31 +00:00
Subramanya Sastry a944352878 Extracted token-related helpers from Util to TokenUtils
* Things to investigate as followups:
  - Should this be part of the Token base class in parser.defines.js?
  - Can we remove nowiki & cite usage of these helpers? Why do they
    need to know about (parser internals) tokens?

Bug: T208360
Change-Id: Ib962b4acf9534852240fcb083ce67d696a997a83
2018-10-30 18:05:24 -05:00
Subramanya Sastry e1a6c9a953 Rename parsing pipeline options to something more semantic
* noPwrapping and noPre existed to reproduce the symptomatic
  effects of other behavior / semantics in the parsing pipeline.

  One of that semantic source was the fact that the content
  being parsed in their own pipeline was being using in inline
  contexts and p-wrapping and indent-pre generation doesn't
  make sense in those contexts.

  The other semantic source was the fact that when the content
  being parsed in their own pipeline was embedded "inPHPBlock"
  in the PHP Parser's doBlockLevels sense, i.e. inside a block
  element that existed on the same wikitext source line.

* This patch introduces inPHPBlock and inlineContext as two
  new parsing pipeline options and uses one or the other or both
  where appropriate.

* No change in parser test results as expected.

Change-Id: I2c625456c6593e49b6a247fb9b2f2e3d6021155b
2018-10-02 23:05:53 +00:00
Subramanya Sastry 499c2c4564 Remove more Cite leakage from html2wt code
* This removes Cite leakage in html2wt code by adding PHP parser
  side-effect leakage into the Cite extension configs.
  This is a somewhat temporary solution which we hope to address
  better as part of ongoing cleanup.

* After 4 years, 'a quick hack for now' introduced in 3301393515f
  has been addressed.

* No change in parser test passes.

Change-Id: Ic5f8c160d4eedcc4236bce5f095344bd879188cd
2018-10-02 23:00:15 +00:00
Subramanya Sastry 635be2e906 Tweak extension config a bit more
* Move the name property to the top level

Change-Id: Id8730f35e40ad9f01d250f29ef3c2545fd4fd612
2018-08-30 19:00:35 +00:00
Subramanya Sastry bf0a743c2d Document more extension-API related FIXMEs
* Cite-specific code has leaked in html2wt
* Other possible FIXMEs in Cite about generalizing or
  adding new extension API functions.

Change-Id: I30712a3af81edfce0760f4a45ab694c798fb294a
2018-08-29 21:48:43 +00:00
Subramanya Sastry 62cd9789f2 Tweak extension DOM config for extensibility
* Make the dom part of extension registration / config more general
  to allow for other kinds of dom processors.

* For example, we will probably be letting extensions define DOM
  handlers that lets us take a document's subtree and convert it to
  self-contained top-level document.

Change-Id: I0ddfe3bc677041cedf63e79faa9c5af939953419
2018-08-23 19:39:16 +00:00
Arlo Breault 93371d4dee Support directionality for reference
Ports commit 1ca27aa from extensions/Cite

Bug: T198221
Depends-On: Iaf84966e37cea730c9eca07c19a555971ffeadf3
Change-Id: I28c8efa6fd5cb06220af4399aa26f3d01b8d3761
2018-08-23 14:36:04 -04:00
Arlo Breault a118efbbd7 Ensure the ref.cachedHtml isn't being regenerated needlessly
Change-Id: If319ad282ed7dd437dce400417e4555291a2dc38
2018-08-16 19:34:04 -04:00
Arlo Breault 9928fe4044 Separate which source of data attributes are used in extractRefFromNode
Follow up to 53ae5aa

It's somewhat unclear which attributes belong on the representation for
the fragment, so don't rely on them unnecessarily.

Change-Id: Ib5ba0110291f0c02bd703482813b9567dab63cd6
2018-08-16 19:33:22 -04:00
Subramanya Sastry 8fa5bc3376 Enable extensions to distinguish between <ext /> and <ext></ext>
* This now lets Cite distinguish between <ref></ref> and <ref />
  Seen in improvement in blacklisted output of a parser test.

Bug: T130224
Change-Id: If9511498fe8f6d091f8a725b51810eb452db95de
2018-08-14 21:47:43 +00:00
Subramanya Sastry 1a2b7e796f Remove Cite-specific flag from parser pipeline options
* Use a generic extTagOpts that is opaque to the core parser
  but the individual extension can inspect.

Change-Id: I4d1331604828d583b820084e00af68232ec767f8
2018-08-09 02:00:03 +00:00
Subramanya Sastry d8f4a31efe Handle <references></references> without crashing
* Fixes rt regressions on svwiki:Havre and a bunch of other titles.

Change-Id: I1d31ccf1045ba5a4fef9377101ad4e90a534c1e9
2018-08-09 02:00:01 +00:00
Subramanya Sastry 53ae5aac06 Cite: Get rid of tokenHandler that relies on Parsoid internals
* This still exposes and exploits some Parsoid internals, but
  that can be fixed in the next round of updates.

* Cite (and any other extension) that want to manage fragments
  on their own vs. running the default fragment unpacking routine
  can now specify that they don't want the content unwrapped.

* Changes to parser tests are to rearrange the attrs and body
  attributes which switched positions in data-mw.

* The blacklist changes show that there has actually been an
  improvement in test failures.

Change-Id: I1e1a651e8f2d6d9456bb5849b0bce1f8a87c4446
2018-08-06 21:40:52 +00:00
Subramanya Sastry 116d3c3744 Bump Parsoid release version to 0.9.0
Change-Id: Icd71628513380d7a7fe4fb88fa7e26150ed0e7ef
2018-03-22 13:29:06 -05:00
C. Scott Ananian 4fbcb99cc6 Improve jsdoc summaries.
The summary is the first sentence of the method/class description.  In
some cases we're missing a period so our "summary" runs on and on.

Many of these were fixed up automatically by the
`jsdoc/require-description-complete-sentence` eslint rule, but
it has a few bugs yet (especially
https://github.com/gajus/eslint-plugin-jsdoc/issues/62 ) so we
can't yet turn it on by default.

Change-Id: I5163ed2c52b21090ce018573bb3ff06d50620d73
2018-02-27 22:41:39 +00:00
C. Scott Ananian e82f60f62d Turn on eslint jsdoc/check-tag-names rule.
Change-Id: Ifd9a5319171684015463d6b5759ed2308bff1a5b
2018-02-27 18:10:04 +00:00
C. Scott Ananian 6668c45947 Improve jsdoc
Lots of doc comment tweaks to better match JSDoc standards.  Also use
the latest version of jsdoc-wmf-theme.

Change-Id: I9bf4f22b292b9cff0ad926f31005bccc7c89cbdb
2018-02-22 14:16:58 -05:00