upload.php 12 KB
<?php

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Class NF_FU_Fields_Upload
 */
class NF_FU_Fields_Upload extends NF_Abstracts_Field {

	protected $_nicename = 'File Upload';
	protected $_parent_type = 'textbox';
	protected $_section = 'common';
	protected $_templates = 'file_upload';
	protected $_icon = 'file';
    protected $_test_value = false;
	protected $_settings_all_fields = array(
		'key',
		'label',
		'label_pos',
		'required',
		'classes',
		'manual_key',
		'help',
		'description',
	);

	public function __construct() {
		$this->_name = NF_FU_File_Uploads::TYPE;
		$this->_type = NF_FU_File_Uploads::TYPE;

		parent::__construct();

		$settings = NF_File_Uploads()->config( 'field-settings' );

		$this->_settings = array_merge( $this->_settings, $settings );

        add_action( 'nf_admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) );
	}

	/**
	 * Save the temp file
	 *
	 * @param $field
	 * @param $data
	 *
	 * @return mixed
	 */
	public function process( $field, $data ) {

		/*
		 * If we don't have any files set or we are saving progress, bail early.
		 */
		if ( ! isset( $field['files'] ) || empty( $field['files'] ) || ( isset ( $data[ 'extra' ][ 'saveProgress' ] ) && ! empty( $data[ 'extra' ][ 'saveProgress' ] ) ) ) {
			return $data;
		}

		$submission_data = array();

		// Get common data
		$user_id  = $this->get_user_id();
		$base_dir = NF_File_Uploads()->controllers->uploads->get_path( '' );
		$base_url = NF_File_Uploads()->controllers->uploads->get_url( '' );
		$base_dir .= $data['form_id'] . '/';
		$base_url .= $data['form_id'] . '/';

		// Get custom directory using common data for shortcodes
		$custom_upload_dir    = NF_File_Uploads()->controllers->settings->custom_upload_dir();
		$is_custom_upload_dir = false;
		NF_File_Uploads()->controllers->custom_paths->set_data( 'formtitle', $data['settings']['title'] );

		if ( ! empty( $custom_upload_dir ) ) {
			$custom_upload_dir = stripslashes( trim( $custom_upload_dir ) );
			$custom_upload_dir = NF_File_Uploads()->controllers->custom_paths->replace_shortcodes( $custom_upload_dir );
			$custom_upload_dir = NF_File_Uploads()->controllers->custom_paths->replace_field_shortcodes( $custom_upload_dir, $data['fields'] );

			if ( false !== strpos( $custom_upload_dir, '%filename%' ) ) {
				$is_custom_upload_dir = true;
			}
		}

		// Loop through all files
		foreach ( $field['files'] as $file_key => $file ) {
			$tmp_file = NF_FU_Helper::remove_directory_from_file( $file['tmp_name'] );

			$tmp_file = NF_File_Uploads()->controllers->uploads->get_path( $tmp_file, true );
			if ( ! file_exists( $tmp_file ) ) {
				$data['errors']['fields'][ $field['id'] ] = __( 'Temp file does not exist', 'ninja-forms-uploads' );

				return $data;
			}

			// Remove any path from the filename as a security measure
			$original_filename = NF_FU_Helper::remove_directory_from_file( $file['name'] );

			// Remove the extension from the file name
			$file_parts = explode( '.', $original_filename );
			$ext        = array_pop( $file_parts );

			// Check for blacklisted file types
			if ( NF_FU_AJAX_Controllers_Uploads::blacklisted( NF_FU_AJAX_Controllers_Uploads::get_extension_blacklist(), str_replace( '_', '', trim( $ext ) ) ) ) {
				$data['errors']['fields'][ $field['id'] ] = __( 'File extension not allowed', 'ninja-forms-uploads' );

				return $data;
			}

			if ( ! NF_FU_AJAX_Controllers_Uploads::is_allowed_type( $original_filename ) ) {
				$data['errors']['fields'][ $field['id'] ] = __( 'File extension not allowed', 'ninja-forms-uploads' );

				return $data;
			}

			$original_filename_without_ext = implode( '.', $file_parts );

			// Set the file uploads mergetag values
			Ninja_Forms()->merge_tags[ 'file_uploads' ]->set_filename( $original_filename_without_ext );
			Ninja_Forms()->merge_tags[ 'file_uploads' ]->set_extension( $ext );
			// Set the filename custom shortcode
			NF_File_Uploads()->controllers->custom_paths->set_data( 'filename', $original_filename_without_ext );
			$file_name = $original_filename;

			// Replace %filename% in custom dir
			if ( $is_custom_upload_dir ) {
				$custom_upload_dir = NF_File_Uploads()->controllers->custom_paths->replace_shortcode( $custom_upload_dir, 'filename' );
			}

			// Custom renaming of files
			if ( ! empty( $field['upload_rename'] ) ) {
				$file_name = apply_filters( 'ninja_forms_merge_tags', $field['upload_rename'] );
				$file_name = NF_File_Uploads()->controllers->custom_paths->replace_shortcodes( $file_name );
				$file_name = NF_File_Uploads()->controllers->custom_paths->replace_field_shortcodes( $file_name, $data['fields'] );

				$ext_suffix = '.' . $ext;
				if ( $ext_suffix !== substr( $file_name, - strlen( $ext_suffix ) ) ) {
					$file_name .= $ext_suffix;
				}
			}

			$target_file = trailingslashit( $base_dir . ltrim( $custom_upload_dir, '/' ) ) . ltrim( $file_name, '/' );
			$target_path = dirname( $target_file );
			// Ensure the path exists
			wp_mkdir_p( $target_path );

			// Sanitize the filename for encoding
			$file_name   = sanitize_file_name( str_replace( $target_path, '', $target_file ) );
			$target_file = $target_path . '/' . $file_name;

			if ( file_exists( $target_file ) ) {
				// Make sure we use a filename that is unique
				$original_target_file = $target_file;

				$i = 0;
				do {
					$i++;
					$target_file = str_replace( '.' . $ext, '-' . $i . '.' . $ext, $original_target_file );
				} while ( file_exists( $target_file ) );
			}

			// Get final filename
			$file_name = NF_FU_Helper::remove_directory_from_file( $target_file );

			// Check file extension isn't blacklisted for final file
			$final_file_parts = explode( '.', $file_name );
			$final_ext        = array_pop( $final_file_parts );

			// Check for blacklisted file types
			if ( NF_FU_AJAX_Controllers_Uploads::blacklisted( NF_FU_AJAX_Controllers_Uploads::get_extension_blacklist(), str_replace( '_', '', trim( $final_ext ) ) ) ) {
				$data['errors']['fields'][ $field['id'] ] = __( 'File extension not allowed', 'ninja-forms-uploads' );

				return $data;
			}

			if ( ! NF_FU_AJAX_Controllers_Uploads::is_allowed_type( $file_name ) ) {
				$data['errors']['fields'][ $field['id'] ] = __( 'File extension not allowed', 'ninja-forms-uploads' );

				return $data;
			}

			$custom_path = str_replace( trailingslashit( $base_dir ), '', trailingslashit( $target_path ) );
			$file_url    = trailingslashit( $base_url . ltrim( $custom_path, '/' ) ) . $file_name;

			// Move to permanent location
			$result = rename( $tmp_file, $target_file );
			if ( false === $result ) {
				$data['errors']['fields'][ $field['id'] ] = __( 'File upload error', 'ninja-forms-uploads' );

				return $data;
			}

			// Add to FU table
			$file_data = array(
				'user_file_name'  => $original_filename,
				'file_name'       => $file_name,
				'file_path'       => $target_file,
				'file_url'        => $file_url,
				'upload_location' => 'server',
				'complete'        => 0,
			);

			$upload_id = NF_File_Uploads()->model->insert( $user_id, $data['form_id'], $field['id'], $file_data );

			$file_data['upload_id'] = $upload_id;
			$file_data['custom_path'] = $custom_path;

			// Save to media library
			if ( "1" == $field['media_library'] && "1" == $field['save_to_server']) {
				$file_data['attachment_id'] = NF_File_Uploads()->controllers->uploads->create_attachment( $target_file, $file_name );
			}

			NF_File_Uploads()->model->update( $upload_id, $file_data );

			// Store FU data in the processing object
			$field['files'][ $file_key ]['data'] = $file_data;

			$submission_data[ $upload_id ] = $file_url;
		}

		foreach ( $data['fields'] as $key => $data_field ) {
			if ( $data_field['id'] != $field['id'] ) {
				continue;
			}

			// Set the field value to the array of file upload data
			$data['fields'][ $key ]['value'] = $submission_data;
			// Persist the data for each file
			$data['fields'][ $key ]['files'] = $field['files'];

			break;
		}

		return $data;
	}

	/**
	 * Get current logged in user ID
	 *
	 * @return int
	 */
	protected function get_user_id() {
		$current_user = wp_get_current_user();

		return ( $current_user ) ? $current_user->ID : 0;
	}

	/**
	 * Display uploads URL
	 *
	 * @param int   $id
	 * @param mixed $value
	 *
	 * @return string
	 */
	public function admin_form_element( $id, $value ) {
		if ( ! is_array( $value ) || empty( $value ) ) {
			return $value;
		}

		$new_value = array();
		foreach ( $value as $upload_id => $file_url ) {
			if ( is_array( $file_url ) ) {
				// FU 2.9.x data format
				$upload_id = $file_url['upload_id'];
				$file_url  = $file_url['file_url'];
			}

			$upload = NF_File_Uploads()->controllers->uploads->get( $upload_id );

			if ( ! NF_File_Uploads()->controllers->uploads->file_exists( $upload->data ) ) {
				$new_value[] = __( 'File removed', 'ninja-forms-uploads' );
				continue;
			}

			if ( false !== $upload ) {
				$file_url = NF_File_Uploads()->controllers->uploads->get_file_url( $file_url, $upload->data );
			}

			$new_value[] = sprintf( '<a href="%1$s" target="_blank">%2$s</a><br><input class="widefat" disabled type="text" value="%1$s">', $file_url, __( 'View', 'ninja-forms-uploads' ) );
		}

		return implode( '<br>', $new_value );
	}

	/**
	 * Send already saved files to the front end
	 *
	 * @param array $settings
	 * @param int   $form_id
	 *
	 * @return array
	 */
	public function localize_settings( $settings, $form_id ) {
		// TODO get saved uploads for existing submission
		// $files = array();
		// $settings['files'] = $files;

		$settings['max_chunk_size'] = NF_FU_Helper::get_max_chunk_size();

		// If a max file size is defined for the field use that, else you the global setting
		$max_file_size_mb = NF_File_Uploads()->controllers->settings->get_max_file_size_mb();
		if ( isset( $settings['max_file_size'] ) && ! empty( $settings['max_file_size'] ) ) {
			$max_file_size_mb = $settings['max_file_size'];
		}

		$settings['max_file_size_mb'] = $max_file_size_mb;
		$max_file_size    = NF_File_Uploads()->controllers->settings->file_size_bytes_from_mb( $max_file_size_mb );
		$settings['max_file_size'] = $max_file_size;

		$min_file_size_mb = 0;
		if ( isset( $settings['min_file_size'] ) && ! empty( $settings['min_file_size'] ) ) {
			$min_file_size_mb = $settings['min_file_size'];
		}
		$settings['min_file_size_mb'] = $min_file_size_mb;
		$settings['min_file_size'] = NF_File_Uploads()->controllers->settings->file_size_bytes_from_mb( $min_file_size_mb );

		$nonce_data                    = NF_File_Uploads()->createFieldNonce( $settings['id'] );
		$settings['uploadNonce']       = $nonce_data['nonce'];
		$settings['uploadNonceExpiry'] = $nonce_data['nonce_expiry'];

		$settings['select_files_text'] = ! empty ( $settings['select_files_text'] ) ? $settings['select_files_text'] : apply_filters( 'ninja_forms_upload_select_files_text', __( 'Select Files', 'ninja-forms-uploads' ) );
		$settings['cancel_upload_text'] = ! empty ( $settings['cancel_upload_text'] ) ? $settings['cancel_upload_text'] : apply_filters( 'ninja_forms_upload_cancel_upload_text', __( 'Cancel', 'ninja-forms-uploads' ) );
		if ( ! empty( $settings['upload_types'] ) ) {
			$types = array_map( 'trim', explode( ',', $settings['upload_types'] ) );

			if ( in_array( 'jpg', $types ) && ! in_array( 'jpeg', $types ) ) {
				$types[] = 'jpeg';
			}

			array_walk( $types, function ( &$value ) {
				$value = '.' . ltrim( $value, '.' );
			} );

			$settings['upload_types'] = implode( ',', $types );
		}

		return $settings;
	}

	/**
	 * Load admin scripts for the builder
	 */
	public function admin_enqueue_scripts() {
		$ver = NF_File_Uploads()->plugin_version;
		$url = plugin_dir_url( NF_File_Uploads()->plugin_file_path );
		wp_enqueue_script( 'nf-fu-file-upload', $url . 'assets/js/builder/controllers/fieldFile.js', array( 'nf-builder' ), $ver );
		wp_enqueue_script( 'nf-fu-file-upload-mergetags', $url . 'assets/js/builder/controllers/mergeTags.js', array( 'nf-builder' ), $ver );

		$mergetag_variants = NF_FU_Integrations_NinjaForms_MergeTags::get_default_tags();
		unset( $mergetag_variants['default'] );
		$mergetag_variants = array_keys( $mergetag_variants );

		wp_localize_script( 'nf-fu-file-upload-mergetags', 'nfFileUploadsAdmin', array(
			'mergeTagVariants' => $mergetag_variants,
		) );
	}
}