KeePassDX/app/src/main/java/com/kunzisoft/keepass/database/PwGroupV4.java

/*
 * Copyright 2017 Brian Pellin, Jeremy Jamet / Kunzisoft.
 *     
 * This file is part of KeePass DX.
 *
 *  KeePass DX is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  KeePass DX is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with KeePass DX.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package com.kunzisoft.keepass.database;

import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

public class PwGroupV4 extends PwGroup<PwGroupV4, PwGroupV4, PwEntryV4> implements ITimeLogger {

	public static final boolean DEFAULT_SEARCHING_ENABLED = true;

	private UUID uuid = PwDatabase.UUID_ZERO;
	private PwIconCustom customIcon = PwIconCustom.ZERO;
    private long usageCount = 0;
    private PwDate parentGroupLastMod = new PwDate();
    private Map<String, String> customData = new HashMap<>();

    private boolean expires = false;

    private String notes = "";
	private boolean isExpanded = true;
	private String defaultAutoTypeSequence = "";
	private Boolean enableAutoType = null;
	private Boolean enableSearching = null;
	private UUID lastTopVisibleEntry = PwDatabase.UUID_ZERO;

	public PwGroupV4() {
	    super();
    }

    public PwGroupV4(PwGroupV4 p) {
        construct(p);
        parentGroupLastMod = new PwDate();
    }
	
	public PwGroupV4(String name, PwIconStandard icon) {
		this.uuid = UUID.randomUUID();
		this.name = name;
		this.icon = icon;
	}

    protected void updateWith(PwGroupV4 source) {
        super.assign(source);
        uuid = source.uuid;
        customIcon = source.customIcon;
        usageCount = source.usageCount;
        parentGroupLastMod = source.parentGroupLastMod;
        customData = source.customData;

        expires = source.expires;

        notes = source.notes;
        isExpanded = source.isExpanded;
        defaultAutoTypeSequence = source.defaultAutoTypeSequence;
        enableAutoType = source.enableAutoType;
        enableSearching = source.enableSearching;
        lastTopVisibleEntry = source.lastTopVisibleEntry;
    }

    @SuppressWarnings("unchecked")
    @Override
    public PwGroupV4 clone() {
        // Attributes in parent
        PwGroupV4 newGroup = (PwGroupV4) super.clone();

        // Attributes here
        // newGroup.uuid stay the same in copy
        newGroup.customIcon = new PwIconCustom(this.customIcon);
        // newGroup.usageCount stay the same in copy
        newGroup.parentGroupLastMod = this.parentGroupLastMod.clone();
        // TODO customData make copy from hashmap newGroup.customData = (HashMap<String, String>) this.customData.clone();

        // newGroup.expires stay the same in copy

        // newGroup.notes stay the same in copy
        // newGroup.isExpanded stay the same in copy
        // newGroup.defaultAutoTypeSequence stay the same in copy
        // newGroup.enableAutoType stay the same in copy
        // newGroup.enableSearching stay the same in copy
        // newGroup.lastTopVisibleEntry stay the same in copy

        return newGroup;
    }
	
	public void addGroup(PwGroupV4 subGroup) {
		if ( subGroup == null ) throw new RuntimeException("subGroup");
		childGroups.add(subGroup);
        subGroup.parent = this;
    }
	
	public void addEntry(PwEntryV4 pe) {
		assert(pe != null);
		addChildEntry(pe);
        pe.setParent(this);
    }

    public UUID getUUID() {
        return uuid;
    }

    public void setUUID(UUID uuid) {
        this.uuid = uuid;
    }

    public PwIconCustom getCustomIcon() {
        return customIcon;
    }

    public void setCustomIcon(PwIconCustom icon) {
        this.customIcon = icon;
    }

	@Override
	public PwGroupId getId() {
		return new PwGroupIdV4(uuid);
	}

	@Override
	public void setId(PwGroupId id) {
		PwGroupIdV4 id4 = (PwGroupIdV4) id;
		uuid = id4.getId();
	}

	@Override
	public PwDate getLocationChanged() {
		return parentGroupLastMod;
	}

	@Override
	public void setLocationChanged(PwDate date) {
		parentGroupLastMod = date;
	}

    @Override
    public long getUsageCount() {
        return usageCount;
    }

	@Override
	public void setUsageCount(long count) {
		usageCount = count;
	}

	@Override
	public boolean isExpires() {
		return expires;
	}

	@Override
	public void setExpires(boolean exp) {
		expires = exp;
	}

	@Override
	public boolean allowAddEntryIfIsRoot() {
		return true;
	}

	@Override
	public PwIcon getIcon() {
		if (customIcon == null || customIcon.uuid.equals(PwDatabase.UUID_ZERO)) {
			return super.getIcon();
		} else {
			return customIcon;
		}
	}

    public void putCustomData(String key, String value) {
        customData.put(key, value);
    }

    public boolean containsCustomData() {
	    return customData.size() > 0;
    }

    public String getNotes() {
        return notes;
    }

    public void setNotes(String notes) {
        this.notes = notes;
    }

    public boolean isExpanded() {
        return isExpanded;
    }

    public void setExpanded(boolean expanded) {
        isExpanded = expanded;
    }

    public String getDefaultAutoTypeSequence() {
        return defaultAutoTypeSequence;
    }

    public void setDefaultAutoTypeSequence(String defaultAutoTypeSequence) {
        this.defaultAutoTypeSequence = defaultAutoTypeSequence;
    }

    public Boolean getEnableAutoType() {
        return enableAutoType;
    }

    public void setEnableAutoType(Boolean enableAutoType) {
        this.enableAutoType = enableAutoType;
    }

    public Boolean getEnableSearching() {
        return enableSearching;
    }

    public void setEnableSearching(Boolean enableSearching) {
        this.enableSearching = enableSearching;
    }

    public UUID getLastTopVisibleEntry() {
        return lastTopVisibleEntry;
    }

    public void setLastTopVisibleEntry(UUID lastTopVisibleEntry) {
        this.lastTopVisibleEntry = lastTopVisibleEntry;
    }

    public boolean isSearchingEnabled() {
		PwGroupV4 group = this;
		while (group != null) {
			Boolean search = group.enableSearching;
			if (search != null) {
				return search;
			}
			group = group.parent;
		}
		
		// If we get to the root tree and its null, default to true
		return true;
	}

}