org.verapdf.pd.encryption.AccessPermissions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of parser Show documentation
veraPDF tools for parsing, modifying and creating PDF documents.
There is a newer version: 1.26.1
/**
 * This file is part of veraPDF Parser, a module of the veraPDF project.
 * Copyright (c) 2015, veraPDF Consortium 
 * All rights reserved.
 *
 * veraPDF Parser is free software: you can redistribute it and/or modify
 * it under the terms of either:
 *
 * The GNU General public license GPLv3+.
 * You should have received a copy of the GNU General Public License
 * along with veraPDF Parser as the LICENSE.GPL file in the root of the source
 * tree.  If not, see http://www.gnu.org/licenses/ or
 * https://www.gnu.org/licenses/gpl-3.0.en.html.
 *
 * The Mozilla Public License MPLv2+.
 * You should have received a copy of the Mozilla Public License along with
 * veraPDF Parser as the LICENSE.MPL file in the root of the source tree.
 * If a copy of the MPL was not distributed with this file, you can obtain one at
 * http://mozilla.org/MPL/2.0/.
 */
package org.verapdf.pd.encryption;

/**
 * Represents access permissions for document.
 *
 * @author Sergey Shemyakov
 */
public class AccessPermissions {

    private static final int DEFAULT_PERMISSIONS = 0xFFFFFFFF;
    private static final int PRINT_BIT = 3;
    private static final int MODIFY_BIT = 4;
    private static final int EXTRACT_BIT = 5;
    private static final int MODIFY_ANNOTATIONS_BIT = 6;
    private static final int FILL_IN_BIT = 9;
    private static final int EXTRACT_FOR_ACCESSIBILITY_BIT = 10;
    private static final int ASSEMBLE_DOCUMENT_BIT = 11;
    private static final int DEGRADED_PRINT_BIT = 12;

    private int bits;

    private AccessPermissions(int bits) {
        this.bits = bits;
    }

    /**
     * @return owner permissions where everything is permitted.
     */
    public static AccessPermissions getOwnerPermissions() {
        return new AccessPermissions(DEFAULT_PERMISSIONS);
    }

    /**
     * @param p is P value in encryption dict for standard security handler.
     * @return user permissions specified by p as described in 7.6.3.2 "Standard
     * Encryption Dictionary" in PDF32000_2008.
     */
    public static AccessPermissions getUserPermissions(int p) {
        return new AccessPermissions(p);
    }

    private boolean isPermissionBitOn(int bit) {
        return (bits & (1 << (bit - 1))) != 0;
    }

    /**
     * @return true If supplied with the user password they are allowed to print.
     */
    public boolean canPrint() {
        return isPermissionBitOn(PRINT_BIT);
    }

    /**
     * @return true If supplied with the user password they are allowed to
     * modify the document.
     */
    public boolean canModify() {
        return isPermissionBitOn(MODIFY_BIT);
    }

    /**
     * @return true If supplied with the user password they are allowed to
     * extract content from the PDF document.
     */
    public boolean canExtractContent() {
        return isPermissionBitOn(EXTRACT_BIT);
    }

    /**
     * @return true If supplied with the user password they are allowed to
     * modify annotations.
     */
    public boolean canModifyAnnotations() {
        return isPermissionBitOn(MODIFY_ANNOTATIONS_BIT);
    }

    /**
     * @return true If supplied with the user password they are allowed to fill
     * in form fields.
     */
    public boolean canFillInForm() {
        return isPermissionBitOn(FILL_IN_BIT);
    }

    /**
     * @return true If supplied with the user password they are allowed to
     * extract content from the PDF document.
     */
    public boolean canExtractForAccessibility() {
        return isPermissionBitOn(EXTRACT_FOR_ACCESSIBILITY_BIT);
    }

    /**
     * @return true If supplied with the user password they are allowed to
     * extract content from the PDF document.
     */
    public boolean canAssembleDocument() {
        return isPermissionBitOn(ASSEMBLE_DOCUMENT_BIT);
    }

    /**
     * @return true If supplied with the user password they are allowed to print
     * the document in a degraded format.
     */
    public boolean canPrintDegraded() {
        return isPermissionBitOn(DEGRADED_PRINT_BIT);
    }
}