Preventing Drupal Headaches: Establishing Flexible File Paths From The Start

Preview:

DESCRIPTION

 

Citation preview

FLEXIBLE FILE PATHS FROM THE START

Prevent Drupal Headaches

Wednesday, January 15, 14

training.acquia.com/events

Wednesday, January 15, 14

Who is this for?• New to Drupal?

• Starting a new Drupal site!

• Inherited a new Drupal site and want to know more about configuration

Wednesday, January 15, 14

In this demo• How file path patterns

affect maintenance and migrations

• File upload management

• Future friendly path patterns

Wednesday, January 15, 14

Source of the pain?• Drupal default file

field upload pops ALL files into the same directory

• Often overlooked by developers

• Significant performance impact

• Easy to prevent!

• ...not easy to fix!

Wednesday, January 15, 14

https://drupal.org/node/2128055

A future fix

Wednesday, January 15, 14

A clean room• Protips!• Many potential conflicts with other modules

that control file system. Use clean testing sites.

• See Create a Test Site | Drupal.org

Wednesday, January 15, 14

Out of the box file handling

Getting to grip with the basics

Wednesday, January 15, 14

Basic settings• Global settings• Display options• Upload destination

• Per content type settings• Required?• Help text• Allowed extensions• File directory• Upload size• Description field• Progress indicator• Number of values

Wednesday, January 15, 14

Limiting file types• Security tip: Err on the side of less file

extensions available to the least amount of users

Wednesday, January 15, 14

Description field setting

Wednesday, January 15, 14

The description

Wednesday, January 15, 14

CompareWithout “description” With “description”

Wednesday, January 15, 14

The “display” optionDisplay enabled Display disabled

Wednesday, January 15, 14

Manage field display

Wednesday, January 15, 14

Field report!

Wednesday, January 15, 14

Transliteration• You NEED transliteration. Install it.• Configuration > Media > File system•

Wednesday, January 15, 14

Fix existing file names

Wednesday, January 15, 14

How many is too many?

Wednesday, January 15, 14

The extreme limits• FAT32:• Maximum number of files: 268,435,437• Maximum file size: 4GB• maximum number of files per directory: up to 65535, or less depending

on file names• NTFS:• Maximum number of files: 4,294,967,295• Maximum file size: 16TB currently (16EB theoretically)• Ext2:• Maximum number of files: 10¹⁸• Maximum file size: 2TB• theoretical file per directory limit: 1.3 × 10²⁰ files• Ext3:• Maximum number of files: number of bytes in volume/2¹³.• Maximum file size: 16GB (1KB block) to 2TB (4KB block)•http://stackoverflow.com/questions/466521/how-many-

files-in-a-directory-is-too-manyWednesday, January 15, 14

What’s wrong?• Slow to load directory for maintenance and

migration• Performance hit loading files from that

directory

• Set Max at 1000 or 100,000- well below your “limit”

Wednesday, January 15, 14

File path patterns

Wednesday, January 15, 14

Configure file paths• Basic settings are

limited

• arbitary text

• entitytype/filetype

• Example: article/pdfs

Wednesday, January 15, 14

A better idea!• sites/default/files/YYYY/MM/DD• For high volume uploads

https://drupal.org/node/2128055Wednesday, January 15, 14

Token for file directory!• Set to date

Wednesday, January 15, 14

File (Field) Paths• Set file name also• Node tokens• Transliteration

Wednesday, January 15, 14

Example file path patterns• Parent directory by date• Parent directory by content type• Parent directory by a combination of content

type and author

Wednesday, January 15, 14

Pathauto• Requires Token• Set patterns for paths instead of node/1

Wednesday, January 15, 14

Private and public files

Wednesday, January 15, 14

public:// & private://• Public

• Anyone can download them

• Private

• Controlling access to the files

Wednesday, January 15, 14

Private• Specify a directory

outside of the doc root folder

Example../private

• OR Sub-directory under the public directory

Examplesites/default/files/private

https://drupal.org/documentation/modules/file

Wednesday, January 15, 14

Private directory• Create the private directory at same level as

root folder• Configuration > Media > File system• Set file system path

• System creates .htaccess file

Wednesday, January 15, 14

Per field options• Select private file

• The paths will be like /system/files/ebooks/pressrelease.pdf

Wednesday, January 15, 14

What happens?• Field inherits access publishing settings of

content

Wednesday, January 15, 14

More complex file handling needed?

Wednesday, January 15, 14

A flexible solution• Media +

• File entity +

• OEmbed +

• CKEditor

• Being used in Drupal Commons and Demo Framework

Wednesday, January 15, 14

Demo Framework• A good example of media configuration• http://drupal.org/project/df

Wednesday, January 15, 14

CKEditor Link

https://drupal.org/project/ckeditor_link_filehttps://drupal.org/project/ckeditor_link

Wednesday, January 15, 14

Future friendly

Wednesday, January 15, 14

Media module 2.x• Adds an upload widget

Wednesday, January 15, 14

File entity• File entity (fieldable files)• Add fields to files, group, add display modes,

use Token• Working on getting this into D8

• Documentation at drupal.org/node/1591498

Wednesday, January 15, 14

Fieldable entity

Wednesday, January 15, 14

File browser• File browser and uploader

Wednesday, January 15, 14

File settings (global)• Configuration »

Media » File settings

• Global file field settings

Wednesday, January 15, 14

Granular file permissions

Wednesday, January 15, 14

Display formatter

Wednesday, January 15, 14

Further extend• Media module - Handing files from external

sources and services such as YouTube, Vimeo and Flickr.

• File entity revisions module

Wednesday, January 15, 14

Display formatting• Additional display formatters

Wednesday, January 15, 14

Display formatting

Wednesday, January 15, 14

File view modes

Wednesday, January 15, 14

Fix it? HALP!

Wednesday, January 15, 14

Remediation • Move files to new directories• Recreate all the files using your new tokens• If you embed “inline” files/images, you’d

have to write a script to find and replace.

• Public files are easier.• Drupal handled files are easier.• Example: Media is embedding a file ID.

Wednesday, January 15, 14

Migrate Module• Use Migrate module to do an in-place

migrate of your own site.

drupal.org/project/migrateWednesday, January 15, 14

Professional help• Acquia Professional Services• Migration services

Wednesday, January 15, 14

Recommended