Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Incompatible Plugins: removes duplicator. #39775

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Incompatible Plugins: removes duplicator. #39775

wants to merge 2 commits into from
+4 −2

Conversation

cpapazoglou
Copy link
Contributor

@cpapazoglou cpapazoglou commented Oct 15, 2024 •
edited
Loading

This PR is a collection of changes needed to enable duplicator and duplicator-pro installations in WordPress.com.
Related discussion p1728637897603379-slack-C07QQD54LKU

WordPress.com Team

Duplicator Team

  • duplicator-pro breaks wp-cli commands in WordPress.com.

image

  • When importing a backup the WordPress.com user wasn’t preserved and Jetpack was deactivated. Perhaps something goes off with the wp_users table.

  • duplicator uses ABSPATH to define the location of the wp-content directory ( or other directories ).

if (!function_exists('duplicator_get_abs_path')) {
    function duplicator_get_abs_path() {
        static $absPath = null;
        if (is_null($absPath)) {
            $absPath = wp_normalize_path(ABSPATH);
            if ($absPath == '//' || $absPath == '') {
                $absPath = '/';
            } else {
                $absPath = rtrim($absPath, '/');
            }
        }
        return $absPath;
    }
}

can be modified to

define('PRESSABLE_SITE_ROOT', str_replace( 'wp-content', '', WP_CONTENT_DIR));
if (!function_exists('duplicator_get_abs_path')) {
    function duplicator_get_abs_path() {
        static $absPath = null;
        if (is_null($absPath)) {
            $absPath = wp_normalize_path(PRESSABLE_SITE_ROOT);
            if ($absPath == '//' || $absPath == '') {
                $absPath = '/';
            } else {
                $absPath = rtrim($absPath, '/');
            }
        }
        return $absPath;
    }
}

  • When extracting/installing the duplicated site, the default filename that the plugin generates is named installer.php and must be uploaded and then accessed directly via URL to complete the install process. This filename is blocked for security reasons by Atomic and will return a 403 Forbidden error when you attempt to access it. This can default to anything else such as duplicator.php or install.php and then the file will be accessible.

  • Nice to have - Backups tend to fill storage quickly if you make multiple backups or scheduled backups. It would be cool educating the user about storage implications of multiple backups.

Proposed changes:

  • Allows duplicator and duplicator-pro to be installed in WordPress.com

Testing instructions:

The following are related to the changes introduced from this PR, not related to whether all duplicator issues are fixed.

  • Boot a WordPress.com woa developer blog and sync the code OR follow the instructions in

    jetpack/projects/plugins/wpcomsh/README.md

    Lines 1 to 328 in 5d37c1f

    # wpcomsh
    A helper for connecting WordPress.com sites to external host infrastructure.
    # WordPress.com Site Helper
    With the help of this mu-plugin, an Atomic site is transformed into a WP.com site. It lives in `wp-content/mu-plugins/wpcomsh` and is loaded with `wp-content/mu-plugins/wpcomsh-loader.php`.
    ## Development
    ### Quick Start
    ```
    # Clone the Monorepo somewhere locally
    $ git clone [email protected]:Automattic/jetpack.git
    $ cd jetpack
    $ pnpm install
    $ pnpm jetpack build --deps projects/wpcomsh
    # Specify your development server and path to sync the code to your wp.org install
    $ pnpm jetpack rsync projects/wpcomsh USER@HOST:/path/to/wordpress/wp-content/mu-plugins
    # From the root of the wp.org install you rsynced to (assuming it didn't already have wpcomsh installed)
    $ cd wp-content/mu-plugins
    $ ln -s wpcomsh/wpcomsh-loader.php ./ # or copy the loader to mu-plugins
    # define 'IS_ATOMIC', 'ATOMIC_SITE_ID' and 'ATOMIC_CLIENT_ID' as true so the loader will require wpcomsh
    define( 'IS_ATOMIC', true );
    define( 'ATOMIC_SITE_ID', true );
    define( 'ATOMIC_CLIENT_ID', true );
    ```
    To work on wpcomsh, you need a WP.org site and ideally the Jetpack plugin installed and connected to WP.com.
    You will also need to go through [the Monorepo install procedure](https://developer.jetpack.com/docs/jetpack-development/developer-environment/)
    1. Build the wpcomsh plugin using [the Monorepo tools](https://developer.jetpack.com/docs/jetpack-development/jetpack-cli/#build).
    2. Synchronize the code using `jetpack rsync` into the `wp-content/mu-plugins` folder.
    3. Then, either copy or symlink the `wp-content/mu-plugins/wpcomsh/wpcomsh-loader.php` file to `wp-content/mu-plugins`.
    It acts as a "loader" for wpcomsh and we need this because plugin folders put into `mu-plugins` are not automatically loaded like plugins in `wp-content/plugins`.
    If you want to add some new code to wpcomsh, it's as easy as [creating a pull request](https://developer.jetpack.com/docs/jetpack-development/creating-a-pull-request/) to the plugin code. Make sure to test thoroughly on a WoA dev blog and send the PR to your team for review.
    When working on wpcomsh, follow the [WP.org coding standards](https://codex.wordpress.org/WordPress_Coding_Standards) and make sure to add enough logging (either by returning `WP_Error` and/or by using `error_log`) where needed.
    ## Testing
    There are two stages of manually testing wpcomsh:
    The first one is to set up a WP.org site and test on it (more instructions in the [Development section](#development)).
    However, it's the best if you also install the Jetpack plugin and connect it to WP.com on the WP.org site as that's how AT sites communicate with WP.com -- many things can be tested only with connected Jetpack. We recommend either using your .wpsandbox.me site (PCYsg-5Q0-p2) or use [Vagrant](https://github.com/Varying-Vagrant-Vagrants/VVV) to set up the WP.org site locally on your machine and share it with world (so WP.com can connect to it).
    Note: if you use your `.wpsandbox.me` for testing wpcomsh, use ssh key forwarding so you have all your local ssh keys on the wpsandbox and can clone the wpcomsh GitHub repo. Either run ssh as `ssh -A` or add `ForwardAgent yes` into your `.ssh/config` file. p1490809471078673-slack-C2PDURDSL.
    ### Automated Testing
    #### Unit Testing
    `wpcomsh` runs `phpunit` on GitHub CI for every PR.
    Please try to add unit tests whenever you are adding new features, or modifying existing ones.
    #### Private Site Module
    There is an integration suite built on docker that makes testing what clients to "private" (and non-private) sites should and shouldn't be able to see.
    If you have `docker` installed on your system, the tests can be run like so:
    - `make test-public-access`
    - `make test-private-access`
    Each of the above:
    - Cleans your build directory, etc.
    - Builds the plugin from source (as would happen for the regular deployment process )
    - Spins up containers for:
    - mysql database
    - WordPress (php-fpm)
    - nginx web server
    - WP-CLI
    - node / jest (for the actual testing)
    - Coordinates communication and set up for the above
    - Sets a site to be public or private according to the script invocation
    - Kicks off test specs to validate that appropriate resources are accessible and, in the case of a site being set to private, inappropriate resources are not
    #### Development Mode
    You can enter "development mode" by declaring you are doing so via the `WPCOMSH_DEVMODE` environment variable.
    For example:
    `WPCOMSH_DEVMODE=1 make test-private-access`
    This will:
    - Instruct `make` to bypass the `check` directive (allowing for rules like `build` to run without a clean working directory)
    - Set jest to "watch" for changes to the spec files inside the running container.
    - Watch for changes to specific files on your local machine and copy them to the container on changes.
    - Leave the services running (until you exit with `cmd+c`, etc.), so you can access the running WordPress site to do manual testing (see below)
    In order for WordPress to load the test site correctly, you'll need to access the site with the appropriate site name:
    - Add the following to your hosts file: `127.0.0.1 nginx`
    - Browse to http://nginx:8989 in your favorite web client / browser
    ## Deployment
    - Use the Monorepo deployment tools available in the `tools` folder in the root. For more information on releasing a plugin go to [the Monorepo deployment docs](../../../docs/monorepo.md#plugin-release-tooling).
    - You can view your [successful release here](https://github.com/Automattic/wpcom-site-helper/releases).
    - New versions are deployed when our monitoring detects its release.
    - Note: You can monitor [#atomic-alerts](https://a8c.slack.com/archives/C05GLGHLM8U) channel to see when the new version is deployed.
    #### Deploying new languages
    After every deployment, as described above, please create a new
    branch and run:
    - `make i18n` to update translatable strings and translations and create a new PR
    - Follow Deployment instructions
    ##### How the translation system works?
    - Use the `__( 'My string to be translated', 'wpcomsh' );` code to consume translations.
    - Create a new branch and run the command `make i18n` to convert these new strings into the [wpcomsh.pot](./languages/wpcomsh.pot) file. It will also download previous translations and update .mo and .po files of the [languages folder](./languages/) and will commit them automatically.
    - After merging everything on the trunk branch strings on [wpcomsh.pot](./languages/wpcomsh.pot) file will be automatically inserted into our translation system by this script: fbhepr%2Skers%2Sjcpbz%2Sova%2Sv18a%2Svzcbeg%2Qtvguho%2Qbevtvanyf.cuc%3Se%3Q1oq4q3oo%26zb%3Q12%26sv%3Q2%235-og.
    - After they get translated we need to run again `make i18n` and it will download all translations done by our translation vendor and the community.
    - Deploy and release the translations file.
    - You'll now have your strings translated into production!
    ## Troubleshooting
    When something doesn't work as it should, the first thing to do is [enable error logging in WP](https://codex.wordpress.org/Debugging_in_WordPress) or look into the global PHP error log. It's advisable to install and connect Jetpack when working on wpcomsh. Use [MGS](https://mc.a8c.com/mgs/) to search through Slack channels as that's where most of the development work/chats take place. You can also use PCYsg-5mr-p2 (for example, with PhPStorm). If you still can't figure out the problem, drop a message in the Automated Transfer Slack channel and/or ping [wpcomsh devs](https://github.com/Automattic/wpcomsh/graphs/contributors) directly.
    ## Features
    If you add a feature to wpcomsh, please add it to the following list:
    ### WP.com Footer Credit
    - Replaces any footer credit in our themes with "POWERED BY WORDPRESS.COM."
    - Allows for customization of that message
    ### WP.com Block Theme Footer Credit
    - Footer credits that work on block based themes.
    ### Removal of VaultPress wp-admin notices
    Removal of activation notice, connection notice and error notices. Users should not have to manage VaultPress, report its issues, etc -- that’s why we are hiding those notices.
    ### Hiding plugins links on wp-admin/plugins page
    We don’t allow users to deactivate and edit Akismet, Jetpack, VaultPress so that’s why we hide these links.
    We also hide the bulk plugins deactivation on the wp-admin/plugins page for all the plugins as it was not easily possible to do it only for the aforementioned plugins.
    ### Hiding the Jetpack version number on wp-admin/plugins page
    That version is managed by the Atomic platform, so does not need to be displayed to site owners. They always run the latest version, which may be a version that is not yet released in the WordPress.org directory.
    ### Hiding the Jetpack page "My Jetpack"
    This page is mostly about upselling and cross-discovery of Jetpack feature plugins. Not needed on Atomic sites.
    ### Showing that a plugin is auto-managed
    We show a similar message to the update one under Akismet, Jetpack and VaultPress telling users that those plugins are auto-managed for them (an explanation why they can’t deactivate or edit them).
    ### Denoting Plugins to enable WP.com features
    Plugins that bridge the gap between WP.com and Atomic, enabling WP.com-only features that are part of users' plans, receive a green banner with that information.
    This allows users to make an informed decision when enabling/disabling these plugins.
    ### Symlinking WP.com pub (free) and premium themes
    We keep the WP.com pub and premium themes checked out on Atomic. When users try to install WP.com themes from within Calypso (not possible from wp-admin), wpcomsh hooks into Jetpack themes API and symlinks the WP.com themes from the directory where we keep them on Atomic to user’s `wp-content/themes` folder.
    When a user tries to delete a WP.com theme (only available from Calypso), wpcomsh hooks into Jetpack themes API and unsymlinks the WP.com theme.
    If a WP.com theme is a child theme of another WP.com theme, wpcomsh symlinks both the parent and the child themes. Analogously, if users try to delete a child WP.com theme, wpcomsh unsymlinks both the child and the parent themes. However, if only the parent theme is removed/unsymlinked, wpcomsh doesn’t unsymlink the child theme, making it potentially broken (as the parent theme is removed).
    ### Removal of the “delete” button from WP.com themes in wp-admin
    ### Removal of Theme Editor access from 3-rd party WP.com premium themes in wp-admin
    If a user installs a premium WP.com theme created by a third-party shop (ie not Automattic), we remove access to the Theme Editor as we are prohibited to share the source code of this kind of themes. Both access to wp-admin/theme-editor.php page and the “Editor” link under wp-admin -> Appearance are removed.
    ### Disabling ability to manage plugins/themes after canceling the Business plan subscription
    When a user cancels their Business plan in Calypso, an async job called `at_business_plan_cancellation_flow` is run. This job does various things, such as deactivating all the plugins except Akismet, Jetpack and VaultPress on the transferred site, switching to a WP.com pub theme (which was previously installed on the site) and setting the option `plan_slug` to `free` on the transferred site (options related to Automated Transfer are stored under `at_options` array).
    Setting `plan_slug` to `free`, in turn, adds the `do_not_allow` capability to the list of required capabilities for the following capabilities (for all users -- globally):
    - `activate_plugins`
    - `install_plugins`
    - `edit_plugins`
    - `delete_plugins`
    - `upload_plugins`
    - `update_plugins`
    - `switch_themes`
    - `install_themes`
    - `update_themes`
    - `delete_themes`
    - `upload_themes`
    - `edit_themes`
    ### Points attachment URLs to WP.com
    TODO: needs Jennifer’s clarification.
    After transferring a site from WP.com to Atomic, the media files (such as images) are not immediately moved there and stay on WP.com servers. That’s why we need to point the attachment URLs to WP.com temporarily. A job to move media files is queued shortly after the transfer process finishes.
    ### Bypassing Jetpack Single Sign On login form
    By default, transferred sites have the Jetpack Single Sing On enabled as it’s the only way for WP.com users to log into the site’s wp-admin. However, we want it to be seamless (like on WP.com) without users having to click on the “Log in with WP.com account” button.
    That’s why we bypass this login form with wpcomsh entirely and log the user automatically to wp-admin (or redirect to WP.com if the user is not logged in to WP.com).
    ### Theme_uri of a WP.com theme always wordpress.com
    To distinguish between WP.com themes installed by symlinking and themes uploaded manually, the `theme_uri` of the WP.com symlinked themes is always `wordpress.com` (for example, in Jetpack themes API response).
    ### Add assets/admin-style.css
    All the wp-admin custom styles for transferred sites are in `assets/admin-style.css`. If you need to add some more, please add them to that file.
    ### Checks for Full Site Editing Site Eligibility
    If a site has the `a8c-fse-is-eligible` site option, the site is eligible for Full-Site Editing flows. Flows are only active when a supported theme is active.
    ### Updates Customizer Save/Publish Labels to be consistent with WordPress.com
    Because WordPress.com supports private sites by default, customizer label copy was updated to reduce confusion on what would launch a site or what will save changes on a site.
    ### Custom colors and fonts (+ Typekit fonts)
    On WP.com, we provide custom colors and fonts in a site's Customizer. In order to get them supported on an AT site, wpcomsh imports the `colors`, `custom-fonts` and `custom-fonts-typekit` codebases.
    ### Media Library used space
    Shows space used (e.g. `250MB of 100GB`) in Media library.
    ### Logging
    WPCOMSH provides a hook to log arbitrary information in our Kibana instance.
    You cannot use these function by itself, you need to call a proper hook like so:
    ```php
    do_action( 'wpcomsh_log', "test" );
    ```
    You will see the output here:
    78d11cc3116d62c53c50ae95c04d265b-logstash
    But, logging needs to be turned on via `at_options_logging_on`. You can do that via `/option` endpoint. More tools coming.
    ### WP CLI Commands
    wpcomsh includes [WP CLI](http://wp-cli.org/) commands. They are located in the `./class-wpcomsh-cli-commands.php` file.
    - `wp wpcomsh deactivate-user-plugins`: Bulk deactivate user installed plugins. Supports an `--interactive` mode that asks for each plugin.
    - `wp wpcomsh reactivate-user-plugins`: Bulk re-activate user installed plugins. Supports an `--interactive` mode that asks for each plugin.
    - `wp launch-site`: An easter egg added for WPCOM SSH launch.
    To learn more about writing WP CLI commands consult the [Commands Cookbook](https://make.wordpress.org/cli/handbook/commands-cookbook/).
    ### Store Support
    wpcomsh adds the [wc-api-dev](https://github.com/woocommerce/wc-api-dev) plugin to support Store on WordPress.com
    ### Private Site support
    Enables setting a site to "private." Doing so prevents viewing or interacting with site content to unauthenticated clients (and anyone without `read` capabilities).
    As this module is currently being developed & evaluated, it is only enabled when the `AT_PRIVACY_MODEL` constant is set is set to `wp_uploads` (such that `\Private_Site\is_module_active()` returns `true`).
    ### Experimental Jetpack Blocks
    Enables the "experimental" block bundle [offered in Jetpack](https://github.com/Automattic/jetpack/pull/14104), instead of the default Production bundle.
    Those blocks are considered ready for production, but we don't want to serve to all Jetpack sites yet. When you use this bundle, you'll get all production blocks as well as experimental blocks.
    ### SEO Description Block
    Enables the SEO Description Block that is currently only available for WordPress.com sites.
    ### Navigation Sidebar in the Block Editor
    The navigation sidebar in the [WordPress.com Editing Toolkit](https://wordpress.org/plugins/full-site-editing/) is enabled using a filter. The site helper adds the filter and may use WordPress.com and Automattic specific logic to decide whether to enable it.
    ### Coming Soon
    The Coming Soon PCYsg-u4S-p2 mode is provided via the jetpack-mu-wpcom package PCYsg-Osp-p2 and enabled using a filter. Coming Soon allows users to hide their site behind a Coming Soon page from the site settings page of Calypso.
    ### Nav Unification
    Provides a series of customisations to enable the full Nav Unification experience on Atomic (see pbAPfg-Ou-p2). Includes:
    - hide admin color scheme picker and add notice pointing to WordPress.com Account Settings.
    - persist important WP.com user data to user_option via Jetpack connected user data.
    - activate the Nav Unification feature shipped in Jetpack on Atomic.
    - add a WooCommerce install item to the menu when Woo isn't installed.
    - force disable Nav Unification feature via query string.
    ### Frontend Notices
    Allow the showing of notices on the frontend. Currently we are showing:
    - A top header notice on sites that are close to expire.
    ### GitHub Deploy
    Includes a simple REST API for the GitHub deployment on Atomic: pet6gk-G-p2. Atomic sites that are connected to a GitHub repo will receive `git push` webhook events via WPCOM which are then forwarded onto the connected Atomic site so it can pull down the latest code from GitHub. The WPCOMSH code is also responsible for generating a log file which is returned back to WPCOM and displayed in the Calypso UI at `/hosting-config/:atomic-site`.
    ### Site Monitoring
    The menu item for WoA logging (`/site-monitoring/:siteSlug` in Calypso) is toggled on and off in wpcomsh.
    ## Security
    Need to report a security vulnerability? Go to [https://automattic.com/security/](https://automattic.com/security/) or directly to our security bug bounty site [https://hackerone.com/automattic](https://hackerone.com/automattic).
    ## License
    wpcomsh is licensed under [GNU General Public License v2 (or later)](./LICENSE.txt)
  • Go to /wp-admin/plugin-install.php?s=duplicator&tab=search&type=term
  • Make sure Duplicator is listed and you can install it

Does this pull request change what data or activity we track or use?

No

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 15, 2024 •
edited
Loading

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Oct 15, 2024
@cpapazoglou cpapazoglou mentioned this pull request Oct 15, 2024
Open
@cpapazoglou cpapazoglou self-assigned this Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@cpapazoglou cpapazoglou

Labels
[Plugin] Wpcomsh [Status] In Progress [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@cpapazoglou