wpdk-preferences.php

Go to the documentation of this file.

<?php

class WPDKPreferences {

  public $name;

  public $version;

  public $user_id;

  public static function init( $name, $class_name, $version = false, $user_id = false )
  {
    static $instance = array();
    static $busy = false;

    $preferences = null;

    $name        = sanitize_title( $name );
    $preferences = isset( $instance[$name] ) ? $instance[$name] : ( empty( $user_id ) ? get_option( $name ) : get_user_meta( $user_id, $name, true ) );

    if ( !is_object( $preferences ) || !is_a( $preferences, $class_name ) ) {
      $preferences = new $class_name( $name, $user_id );
    }

    if ( !empty( $version ) ) {
      /* Or if the onfly version is different from stored version. */
      if ( version_compare( $preferences->version, $version ) < 0 ) {
        /* For i.e. you would like update the version property. */
        $preferences->version = $version;
        $preferences->update();
      }
    }

    /* Check for post data. */
    if ( !isset( $instance[$name] ) && !wpdk_is_ajax() ) {
      if ( false === $busy && isset( $_POST['wpdk_preferences_class'] ) && !empty( $_POST['wpdk_preferences_class'] ) &&
        $_POST['wpdk_preferences_class'] == get_class( $preferences )
      ) {
        $busy = true;
        if ( isset( $_POST['wpdk_preferences_branch'] ) && !empty( $_POST['wpdk_preferences_branch'] ) ) {
          $branch = $_POST['wpdk_preferences_branch'];

          /* Reset to default a specified branch. */
          if ( isset( $_POST['reset-to-default-preferences'] ) ) {
            add_action( 'wpdk_preferences_feedback-' . $branch, array(
              $preferences,
              'wpdk_preferences_feedback_reset'
            ) );
            $preferences->$branch->defaults();
            $preferences->update();
          }

          /* Update a specified branch. */
          elseif ( isset( $_POST['update-preferences'] ) ) {
            add_action( 'wpdk_preferences_feedback-' . $branch, array(
              $preferences,
              'wpdk_preferences_feedback_update'
            ) );
            $preferences->$branch->update();
            $preferences->update();
          }
        }

        /* Reset all preferences. */
        elseif ( isset( $_POST['wpdk_preferences_reset_all'] ) ) {
          $preferences->defaults();
          $preferences->update();
        }

        /* Try for import/export. */
        else {
          $preferences = WPDKPreferencesImportExport::init( $preferences );
        }
      }
      $busy = false;
    }

    $instance[$name] = $preferences;

    return $instance[$name];
  }

  protected function __construct( $name, $user_id = false )
  {
    $this->name    = sanitize_title( $name );
    $this->user_id = $user_id;
    $this->defaults();
  }

  public function wpdk_preferences_feedback_reset()
  {
    $message = __( 'Your preferences were successfully restored to defaults values!', WPDK_TEXTDOMAIN );
    $alert   = new WPDKTwitterBootstrapAlert( 'info', $message, WPDKTwitterBootstrapAlertType::SUCCESS );
    $alert->display();
  }

  public function wpdk_preferences_feedback_update()
  {
    $message = __( 'Your preferences values were successfully updated!', WPDK_TEXTDOMAIN );
    $alert   = new WPDKTwitterBootstrapAlert( 'info', $message, WPDKTwitterBootstrapAlertType::SUCCESS );
    $alert->display();
  }

  public function get()
  {
    return empty( $this->user_id ) ? get_option( $this->name ) : get_user_meta( $this->user_id, $this->name, true );
  }


  public function defaults()
  {
    die( __METHOD__ . ' must be override in your subclass' );
  }

  public function delta()
  {

    /* Check if exists a store version. */
    $store_version = $this->get();

    /* Get subclass name. */
    $subclass_name = get_class( $this );

    /* Prepare an onfly instance. */
    $delta = $instance = new $subclass_name( $this->name );

    if ( !empty( $store_version ) ) {

      /* In rare case could happen that the stored class is different from onfly class. */
      if ( !is_a( $store_version, $subclass_name ) ) {
        $this->delete();
        $instance->update();
      }
      else {
        /* Do delta. */
        $delta = WPDKObject::__delta( $instance, $store_version );
        $delta->update();
      }
    }
    return $delta;
  }

  public function update()
  {
    if ( empty( $this->user_id ) ) {
      update_option( $this->name, $this );
    }
    else {
      update_user_meta( $this->user_id, $this->name, $this );
    }
  }

  public function delete()
  {
    if ( empty( $this->user_id ) ) {
      delete_option( $this->name );
    }
    else {
      delete_user_meta( $this->user_id, $this->name );
    }
  }

}

class WPDKPreferencesBranch {

  public function __construct()
  {
    $this->defaults();
  }

  public function defaults()
  {
    die( __METHOD__ . ' must be override in your subclass' );
  }

  public function update()
  {
    // Override to process post data
  }

}


class WPDKPreferencesImportExport {

  const ERROR_NONE           = false;
  const ERROR_READ_FILE      = 1;
  const ERROR_MALFORMED_FILE = 2;
  const ERROR_VERSION        = 3;
  const ERROR_USER_ID        = 4; // Not used at this momnent

  private $error;

  private $import;

  public $preferences;

  public static function init( $preferences )
  {
    $import_export = new WPDKPreferencesImportExport( $preferences );
    return $import_export->preferences;
  }

  private function __construct( $preferences )
  {
    $this->preferences = $preferences;
    $this->import      = '';
    $this->error       = false;

    /* Check post data. */
    if ( isset( $_POST['wpdk_preferences_export'] ) ) {
      $this->download();
    }
    /* Import. */
    elseif ( isset( $_POST['wpdk_preferences_import'] ) ) {
      //add_filter( 'wpdk_preferences_import_export_feedback', array( $this, 'wpdk_preferences_import_export_feedback' ) );
      add_action( 'wpdk_header_view_' . $preferences->name . '-header-view_after_title', array(
        $this,
        'wpdk_preferences_import_export_feedback'
      ), 99 );

      if ( $_FILES['file']['error'] > 0 ) {
        $this->error = self::ERROR_READ_FILE;
      }
      else {
        $this->import( $_FILES['file']['tmp_name'] );
      }
    }
  }

  private function import( $filename )
  {
    $this->import = unserialize( gzinflate( file_get_contents( $filename ) ) );

    /* Check for error in file structure. */
    if ( !is_object( $this->import ) || !is_a( $this->import, get_class( $this->preferences ) ) ) {
      $this->error = self::ERROR_MALFORMED_FILE;
      return;
    }

    /* Check for wrong version. */
    if ( version_compare( $this->import->version, $this->preferences->version ) > 0 ) {
      $this->error = self::ERROR_VERSION;
      return;
    }

    /* @todo Check for import preferences from other users
     * if ( !empty( $this->import->user_id ) ) {
     * $user_id = get_current_user_id();
     * if ( $user_id !== $this->import->user_id ) {
     * $this->error = self::ERROR_USER_ID;
     * return;
     * }
     * }
     */

    $this->preferences = $this->import;

    /* Apply. */
    $this->preferences->update();
  }

  private function download()
  {
    /* Create a filtrable filename. Default `name-preferences.wpx`. */
    $filename = sprintf( '%s.wpx', $this->preferences->name );
    $filename = apply_filters( 'wpdk_preferences_export_filename', $filename, $this->preferences );

    /* GZIP the object. */
    $buffer = gzdeflate( serialize( $this->preferences ) );

    header( 'Content-Type: application/download' );
    header( 'Content-Disposition: attachment; filename="' . $filename . '"' );
    header( 'Cache-Control: public' );
    header( "Content-Length: " . strlen( $buffer ) );
    header( 'Pragma: no-cache' );
    header( 'Expires: 0' );

    echo $buffer;
    exit;
  }

  public function wpdk_preferences_import_export_feedback()
  {
    $title   = __( 'Warning!', WPDK_TEXTDOMAIN );
    $content = '';

    switch ( $this->error ) {

      /* All ok. */
      case self::ERROR_NONE;
        $title   = __( 'Successfully!', WPDK_TEXTDOMAIN );
        $content = __( 'Import complete.', WPDK_TEXTDOMAIN );
        break;
      /* Error while reading upload file. */
      case self::ERROR_READ_FILE:
        $content = sprintf( '%s %s', __( 'Error while read file! Error code:', WPDK_TEXTDOMAIN ), $_FILES['file']['error'] );
        break;
      /* Error while uncompress upload file. */
      case self::ERROR_MALFORMED_FILE:
        $content = __( 'Malformed file.', WPDK_TEXTDOMAIN );
        break;
      /* Version export error. */
      case self::ERROR_VERSION:
        $content = __( 'Wrong file version! You are try to import a most recent of export file. Please update your plugin before continue.', WPDK_TEXTDOMAIN );
        break;
    }

    $alert = new WPDKTwitterBootstrapAlert( 'feedback', $content, empty( $this->error ) ? WPDKTwitterBootstrapAlertType::SUCCESS : WPDKTwitterBootstrapAlertType::WARNING, $title );
    $alert->display();
  }

}