Commit graph

366 commits

Author SHA1 Message Date
Subramanya Sastry 0cc3ca1b98 Move DomSourceRange to Core; ParsoidExtensionApi to Ext
* At this point, DSR is a first-class Parsoid concept and
  extensions will need to use this as well. So, make it part
  of the Core/ namespace to capture high-level concepts that
  might be used outside Parsoid itself.

* Move ParsoidExtensionApi to the Ext directory since that is
  where it best belongs.

Change-Id: If824c4af9e2f8d658f1cb726cbd837222b60790d
2020-03-16 15:52:08 +00:00
Subramanya Sastry 866bc09353 ParsoidExtensionAPI: Update docs
Change-Id: Id1bdf28254cda3ff32cd8ecab6eea8adfce31144
2020-03-06 19:07:23 -05:00
Subramanya Sastry 34b7080ebf ParsoidExtensionAPI: Add additional API methods
* Added API method to let content-model extensions to add metadata
  to <head>.
* The title API methods seem legitimate
* But, the newAboutId helper is suspect -- currently only needed
  by Cite. Explore if we can eliminate the need for this helper.
* This eliminates a few more Env use sites from extensions.

Bug: T242746
Change-Id: I0e982d4be173f7d49df19467fbf49c11d428e650
2020-03-06 19:07:17 -05:00
Subramanya Sastry 25bd654ce1 Cite: Eliminate knowledge of DOM state from a few more call sites
* Cite (or other extensions) don't need to explicitly load/store
  data attributes from html attributes to/from the data bag held
  separately from the DOM.

Bug: T242746
Change-Id: I4a52be2b06ccfe53d0cf81987af12a1d139fef4c
2020-03-06 22:01:40 +00:00
Subramanya Sastry 5397598842 Provide extensions SiteConfig & PageConfig access via ParsoidExtensionAPI
* Presumably, extensions would benefit from having access to the
  wiki config via SiteConfig.

* Yet to figure out if extensions need access to the page config.

* But, with this change, extensions don't need $env when all they
  need is access to the wiki and page config.

Bug: T242746
Change-Id: I88736f882f185ee9376b73f7e4bb0b2bd318bb1a
2020-03-05 19:30:38 -05:00
Subramanya Sastry aebd6bcdcd Save fragments without storing data-* attribs onto the node
* This seems to work and also will make the job of keeping extensions
  free of DOM state easier.

  Arlo clarifies that this wasn't necessary since f7594328 and could
  have been cleaned up there.

Change-Id: I96edaa5b2743f1ce0d8596acfdc59035491541cb
2020-03-02 23:22:47 +00:00
Subramanya Sastry 2f9f5e25ef Pass $extApi, not $env to extension callbacks
* $env was unused in extension DOM post processors. So get rid of
  that since we are already in the process of removing $env access
  to extensions.

* html2wtPreProcessor is currently unimplemented but there is WIP
  code in Parsoid/JS that can be revived at a later point. No need
  to pass $env here as well.

* In both cases, pass $extApi so they can access any necessary
  helpers or state provided by that API object.

Bug: T242746
Change-Id: I1d1544af817d03e01a569e6aeaeed0d6c3058fc0
2020-03-02 19:21:07 +00:00
Subramanya Sastry 14d9ed27f0 Remove direct access to Sanitizer from extension code
* Proxy all accesses to the santiizer via appropriately named methods
  in the ParsoidExtensionApi interface

Bug: T242746
Change-Id: I9d3d98639bb98b4abe404139786517591323d61d
2020-02-20 23:23:22 -06:00
Subramanya Sastry d0a9c42c98 Cite: Remove more Parsoid internals knowledge
* Remove use of $env from ReferencesData and RefGroup by
  providing high-level helpers in ParsoidExtensionAPI.

  - Given a fragment id, provide helpers to fetch fragment DOM
    or fragment HTML
  - Fetch the URI for the current page (being parsed)

* There is still a lot of subtle knowledge Cite has about
  how data-parsoid and data-mw attributes are held off to the
  side in a bag and all the pp* and load/store manipulation
  of those attributes. It would be an interesting exercise
  to purge this implementation of those notions OR figure out
  high-level concepts that we document as being part of Parsoid
  reality that we'll forever support.

Bug: T242746
Change-Id: I29ff154f2f17123b9756dfd2f3b422f0b30222b1
2020-02-11 19:47:28 +00:00
Subramanya Sastry 1f87104378 Simplify TokenUtils::kvToHash
* Get rid of unused args and simplifyy method
* In preparation for more cleanup of extension code

Change-Id: I9bdce2e0c9254405d4c3ed61926b54a3997a0c22
2020-02-11 15:50:58 +00:00
Subramanya Sastry 70e38c1ae4 Use extension config option for html2wt formatting of extension tags
Bug: T242746
Change-Id: If96056d9bc75afa9390c2f8aab0da5eab60cc537
2020-02-07 18:03:56 +00:00
Subramanya Sastry 5e256b48aa Start untangling Parsoid internals from extensions
* In this patch, toDOM, fromDOM, and DOM postprocessor extension
  methods all get a ParsoidExtensionAPI object. These API objects
  are constructed at the appropriate times in the wt2html and html2wt
  pipelines.

* Got rid of direct references to SerializerState from fromDOM
  methods in extensions.

* Exposed generic serialization and wikitext escaping methods
  in ParsoidExtensionAPI for extensions to leverage. The implementation
  of these methods is partial and only supports current usage
  of extensions in Parsoid's repo. This will need to be fully
  fleshed out going forward.

* Stopped exposing wt2html options in toto and provided more specific
  convenience methods.

* Reduced direct access to the Env object in a few more places.

* Cite has code to inspect embedded HTML in data attributes of a node.
  Moved this code out of Cite into ParsoidExtensionAPI which reduces
  knowledge that extensions need. Unlike the other cleanups, this one
  is more of a convenience method since this code only requires
  knowledge of a publicly published spec. But, nevertheless an useful
  cleanup since it simplifies Cite's complexity just a bit.

* More followup work is needed.
  - before/after methods should be eliminated in favour of a config flag
    that implements the inline/block layout option. Once this is done,
    extensions will no longer need direct access to the SerializerState
    internal object.
  - Env exposure should be reduced.
  - Provide access to Sanitizer via ParsoidExtensionAPI instead of
    needing extensions to directly import it.
  - It should be possible to eliminate the need for extensions to know
    about DSR / DSR-shifting and do it automatically via some high-level
    conceptual flag.
  - It might also be possible to infer source offsets directly via args
    instead of passing that explicitly.
  - Should we provide a convenience helper class with access to all the
    src/Utils/* methods?

Bug: T242746
Change-Id: I7ffb5aa52a84854a9d363a0e8f1ce650241f1c41
2020-02-06 20:55:27 -05:00
C. Scott Ananian 5d200e0bf0 Move all code from Parsoid to Wikimedia\Parsoid namespace
This matches core conventions.

Bug: T240054
Change-Id: I5feb8a6b41503accd01a740195256e9092609272
2020-02-03 21:34:49 +00:00
Subramanya Sastry 787e6b1cfe No need to explicitly pass 'inTemplate' flag from extension code
* ParsoidExtensionAPI has this info already.

Bug: T242746
Change-Id: I60c393716f31d6f288c54910399bef6e4a42f3dc
2020-01-22 12:56:43 +05:30
Arlo Breault cff011ff0a Serialize reference tags by themselves on a line
Bug: T242513
Change-Id: I0744eb27e357e63667da86347d3653f063789fca
2020-01-16 13:40:36 -05:00
Subramanya Sastry ddbca68066 Rename DOM handling methods toDOM/fromDOM to reflect reality
* For extensions, the fromHTML --> fromDOM renaming mirrors the
  toDOM extension method.

Change-Id: Ic361bd0b5a8849c3033f55cfcae6e1cb36f68a10
2020-01-16 20:25:36 +05:30
Subramanya Sastry a8a6951f9c Bump Parsoid/JS version to 0.11.0 for deb package release
Change-Id: I2f5df42fe7d8275f0a3d4d77cd4cd410f76e9974
2020-01-11 13:43:13 +05:30
Subramanya Sastry 1ec3fdbe33 Minor: Rename a function arg
Change-Id: I689eef42414749c2cf47be55268b5bb2575d8078
2019-11-22 20:54:03 +00:00
Subramanya Sastry ad229c1ac0 One more fix for T235656
It is about time to implement a generic fix for T214994 which will
capture the Cite-specific scenario we are tackling here in bits
and pieces. We have fragments of a T214994 solution spread in
Utils/ and here while tackling shiftDSR and convertOffsets
for Parsoid/PHP. So, someone needs to take a look at all these
pieces and implement the necessary abstraction.

As part of that, maybe we also need to revisit our embedded HTML
data-* representation so there is a uniform way to inspect these
attributes rather than every semantic element (template, extensions,
lang variants, media) choosing their own custom embedding scheme
which makes discoverability harder and error-prone.

Change-Id: Ifd19d2d8d20dbd0dda0fa1cc338a07afb37c4213
2019-11-06 14:03:29 -06:00
Arlo Breault 22832c1d41 Bump mediawiki-phan-config to 0.8.0
This managed to catch a few bugs where there is likely coverage gaps.

The regenerated plugin list again comments out a few that generated too
much noise but may be worthwhile follow ups.

Change-Id: I746abd0f1406b4b7ffa497afdad3939fe437c25d
2019-11-05 15:31:36 -05:00
C. Scott Ananian d55a8db4e4 Clean up typeOf matching in Cite extension
Change-Id: I88388a2120cc1bd79ef7ec5de3c40e93db22844f
2019-11-04 20:08:33 +00:00
Subramanya Sastry 965203b301 Process <ref>s found in nodes with mw:ExpandedAttrs typeof
* This is an instance of a bigger issue that we need to look closely
  when we are integrating Parsoid with core parser.

Bug: T235656
Change-Id: I3d652727293461c7968e83be8994ba0572bae8e4
2019-10-29 21:52:09 +00:00
Subramanya Sastry 79183b596d Cite wt->html: Match html->wt and make datamw->body an object not an array
* Though this doesn't immediately affect anything, it just makes
  usage a bit more consistent.

* A followup patch that fixes gaps in shiftDSR code will now be
  able to reference the html property as dmw->body->html to match
  html2wt usage.

Change-Id: I9dfcd9d40205f6e64e139bf3f75a322915af3232
2019-10-15 19:43:11 -05:00
Subramanya Sastry 2be3ab72c6 References.php: Use strlen not mb_strlen to count page length
* When a page is missing an explicit <references /> tag, we insert
  an implicit <references /> tag and assign it a zero-width DSR with
  a starting offset equal to the length of the page. However, now that
  we have byte offsets, that should have been strlen, not mb_strlen.

  This was causing incorrect DSR assignment on this implicit tag
  and causing trailing newline selser diffs on these pages.

* Debugged on this reduced test case: "* a – b <ref>x</ref>\n\nc\n\n"
  and comparing selser trace and then DSR offsets on the DOMs.

Change-Id: I8aebf307197935259df78251fb4a26c593f29603
2019-10-03 23:14:33 -05:00
Subramanya Sastry 167a28bbea Use PHPUtils::lastItem() over end() in more places
Tim Starling has indicated in couple different places that end(..)
is not preferred and he had implemented a private version of lastItem
in the PEG grammar code whereas PHPUtils::lastItem was recommending
use of end(..).

In this patch, I moved the implementation from the grammar to PHPUtils
and replaced end(..) with PHPUtils::lastItem in a number of places in
the codebase. We should discuss whether we want to use this helper
everywhere.

Resolved a couple of PORT-FIXMEs in the bargain.

Change-Id: I837f2a98003df8ab7dbdf9af045e17bdd6e27799
2019-10-03 03:41:39 +00:00
Arlo Breault 6d0c6201dd Resolve some PORT-FIXMEs around Selser construction
And rename Selser -> SelserData

Change-Id: Ia6a23f4194d4c05b7269498bfbbd31e236c86ce6
2019-09-19 17:53:57 -04:00
Subramanya Sastry 23b666ad14 Unconditionally add D modifier to regexps ending in $ check
* We could potentially also exclude regexps for node name checks
* A few additions looks like could potentially have caused subtle
  failures in edge cases.
* Unrelated changes: Used # regexp terminator in a number of regexps
  to eliminate escaping of / character.

Bug: T231980
Change-Id: Ie2451349684c248d93e064e3e7009d0d2d60acf3
2019-09-09 21:43:58 +00:00
Arlo Breault e6204a1561 Test against ref name length instead of coercing to bool
Since "0" is falsy in php.

Couple tests now pass.

Change-Id: I9b62b9f78680de6e1d5c31723af7212a58a535f3
2019-08-14 18:59:28 -04:00
Arlo Breault dc7d19a1a8 Avoid normalizing fragment being passed to newFromText
Matches what we're doing on the JS side.

Change-Id: I93a0770b84e496ddf3290a36fa6b8073919ed183
2019-08-14 22:23:53 +00:00
Arlo Breault b202964b5a Fix dropping nested refs
The extension handler expects a `null` for this, `false` is an
indication not to use the toDOM handler.

php bin/parserTests.php tests/citeParserTests.txt --filter "CircularRef" --wt2html

Change-Id: I849a9aca1133f8a793c9d77e05f192a6af5d78f9
2019-08-09 16:48:03 -04:00
Tim Starling b002802b4b Workaround for PHP bug involving constant arrays cast to objects
Introduce PHPUtils::arrayToObject() which duplicates the array before
converting it to an object. Workaround for
https://bugs.php.net/bug.php?id=78379

Bug: T228346
Change-Id: If9ef35e9e5183117025bc9cd705b695f270aa244
2019-08-07 02:33:44 +00:00
Subramanya Sastry c7e6c2d0f8 Bug fixes in Cite.php + Parsoid Extension API
Two classic PHP errors
- string '0' is a falsy value in if conditions and so we need an
  explicit === '' check for empty strings
- arrays need to be passed by reference to capture modifications
  in callers.

Change-Id: I07d0e39c44a923ac1faeb2de01433e951c3de914
2019-07-29 13:24:17 -05:00
Subramanya Sastry 13cbce41c5 Assorted fixes for problems found from parserTest runs
Change-Id: I75b158df00f54ff163455c630b51f2c00af24888
2019-07-18 09:01:46 -05:00
Subramanya Sastry 8757e89e21 Assorted fixes after running PHP parser tests in different modes
* Fixes crashers, notices emitted during parser test runs.

Change-Id: I0e337f22594f6cd36a7dff21afaa7a9dc9c862cf
2019-07-15 17:00:45 -05:00
Subramanya Sastry d76ac30440 Followup to 0f0d6e0e: Fix sig & return value to match ext-api changes
* The new PS of 0f0d6e0e missed this.

Change-Id: I731bd85dc3ae4522d64c87085f49330691a10e36
2019-07-12 17:32:17 -05:00
Subramanya Sastry 0f0d6e0ed7 Followup to 7b6839ac: Fix crashers during serialization
* Don't unconditionally run fromHTML and before handlers without
  checking if we have a native extension handler.

* Remove unintential implementation of `before` in Ref.php

* Hybrid tests for Cite now passes again.

* Discovered while running native parser tests and isolated those
  crashers to this.

Change-Id: I45b48b595a5aee2b8b8d00b4ebcf73a5ea7bc8a3
2019-07-12 13:48:50 -04:00
C. Scott Ananian 7b6839ac59 Remove SerialHandler interface in favor of default methods on ExtensionTag
Change-Id: I245c4b9393720982654d5f4e944329c9d764e04e
2019-07-11 18:51:55 +00:00
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