/*

    File: file_wad.c

    Copyright (C) 2020 Christophe GRENIER <grenier@cgsecurity.org>

    This software 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 2 of the License, or
    (at your option) any later version.

    This program 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 this program; if not, write the Free Software Foundation, Inc., 51
    Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

 */

#if !defined(SINGLE_FORMAT) || defined(SINGLE_FORMAT_wad)
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#include <stdio.h>
#include "types.h"
#include "common.h"
#include "filegen.h"

/*@ requires valid_register_header_check(file_stat); */
static void register_header_check_wad(file_stat_t *file_stat);

const file_hint_t file_hint_wad = {
  .extension = "wad",
  .description = "Doom",
  .max_filesize = PHOTOREC_MAX_SIZE_32,
  .recover = 1,
  .enable_by_default = 1,
  .register_header_check = &register_header_check_wad
};

struct wad_header
{
  uint32_t identification;
  uint32_t numlumps;
  uint32_t infotableofs;
} __attribute__((gcc_struct, __packed__));

/*@
  @ requires buffer_size >= sizeof(struct wad_header);
  @ requires separation: \separated(&file_hint_wad, buffer+(..), file_recovery, file_recovery_new);
  @ requires valid_header_check_param(buffer, buffer_size, safe_header_only, file_recovery, file_recovery_new);
  @ ensures  valid_header_check_result(\result, file_recovery_new);
  @ assigns  *file_recovery_new;
  @*/
static int header_check_wad(const unsigned char *buffer, const unsigned int buffer_size, const unsigned int safe_header_only, const file_recovery_t *file_recovery, file_recovery_t *file_recovery_new)
{
  const struct wad_header *hdr = (const struct wad_header *)buffer;
  const unsigned int infotableofs = le32(hdr->infotableofs);
  if(le32(hdr->numlumps) == 0)
    return 0;
  if(infotableofs < sizeof(struct wad_header))
    return 0;
  reset_file_recovery(file_recovery_new);
  file_recovery_new->extension = file_hint_wad.extension;
  file_recovery_new->min_filesize = infotableofs;
  return 1;
}

static void register_header_check_wad(file_stat_t *file_stat)
{
  register_header_check(0, "PWAD", 4, &header_check_wad, file_stat);
#ifndef DISABLED_FOR_FRAMAC
  register_header_check(0, "IWAD", 4, &header_check_wad, file_stat);
#endif
}
#endif