(dev/core#2994) IFrame Connector - Add extension to allow remote iframes (*incubation*) #29496
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
__Background__: The `Civi::url()` helper takes logical URLs (`frontend://civicrm/event/info`) and translates to physical URLs. __Before__: The schemes are specifically `frontend://`, `backend://`, and `current://`. Logical schemes are only defined by `civicrm-core` and its UF-integrations. __After__: * Extensions can define new logical schemes. * The `http://` and `https://` schemes are also supported. __Technical Details__: * To add a new scheme, you implement event `civi.url.render.MYSCHEME`. The listener should translate the logical URL into a physical URL. * Since physical URLs will typically be HTTP(S), we add some more helpers that are convenient for outputing HTTP(S), as in: In particular, the `merge()` utility should help with this.
|
🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷 Introduction for new contributors...
Quick links for reviewers...
|
The `System::url()` API has a contract designed for a "two scheme world"
(frontend or backend). The gist of the contract is this:
- By default, the URL is rendered in the *current* environment (frontend xor backend)
- You may optionally request a specific environment (`$frontend=TRUE` or `$forceBackend=TRUE`).
We're entering a "multi-scheme" world (with frontend or backend; and also:
web-service or oembed). This is more apparent in the `Civi::url()` API,
where you can give a scheme (`current://` or `frontend://` or `oembed://`).
But we still have many calls to `System::url()`.
The patch preserves the behavior of `System::url()` for all normal work in the existing
frontend/backend environments. But it adds support for other "current" environments:
==> If you're processing an oembed page-view and call `System::url()` (with
default options), then it should return the oembed-style URL.
Of course, if you give an explicit flag (`$frontend`, `$forceBackend`), then that
will still be respected.
totten
force-pushed
the
master-iframe
branch
from
59b6695 to
55853cf
Compare
|
There's currently one test failure ( |
totten
force-pushed
the
master-iframe
branch
from
55853cf to
d96b8aa
Compare
|
Yes I can confirm I have been able to generate a suitable iframe where d10 is the provider and a WP is consumer so far |
.gitignore
Outdated
| @@ -22,6 +22,7 @@ | |||
| !/ext/financialacls | |||
| !/ext/contributioncancelactions | |||
| !/ext/recaptcha | |||
| !/ext/oembed | |||
There was a problem hiding this comment.
@totten it seems you have re-named the ext to be iframe but this is still set to be oembed?
There was a problem hiding this comment.
Thanks @seamuslee001. Fixed.
totten
force-pushed
the
master-iframe
branch
from
d96b8aa to
fcc2036
Compare
|
Reviewed the code, tried out the functionality. Good to merge. |
|
Failures are a Leap Day Present. |
|
Every page in drupal 8 is now giving php warnings - followup PR: #29560 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
The humble
<iframe>has been around since HTML 4, and it provides a widely-known mechanism to embed content from other web-sites. However, modern<iframe>s are more complicated than their ancestors -- they require additional adaptations to operate with current browsers. And (at the CMS layer)<iframe>support is often disabled by default.This PR provides opt-in support for
<iframe>s for CiviCRM. By enabling the extension ("IFrame Connector"), one can allow external web-sites to embed CiviCRM pages.UF=DrupalandUF=Drupal8. But we need to develop similar connectors for other UFs, and we will probably revise the options further in the coming months. Therefore, it is hidden (<tag>mgmt:hidden</tag>) from the main list of extensions.info.xmlhave been cleaned up more. The extension has been renamed(oembed=>iframe) from earlier drafts.Before
After
Quick Start
Enable the extension via CLI/API:
The "System Status" will prompt you to deploy the connector script:
In "Administer > System Settings > IFrame Connector", you can configure how embedded pages will work:
Pick a public CiviCRM page (eg
civicrm/contribute/transact?reset=1&id=1).On an external website, you can make an HTML page which embeds the CiviCRM page:
Comments
The included
ext/iframe/README.mdincludes more, discussion, and list of TODOs.Why rename the extension? In retrospect, the current code is actually about IFRAMEs. IFRAMEs can be used with or without oEmbed. The follow-up will provide an
oembedextension which is actually about oEmbed (i.e. the protocol for translating copy-pasted URLs into IFRAME snippets). Andoembedwill depend oniframe.